Registers a user for your enterprise.

If you are an administrator in Data Management (DMS), you can call this operation to register a user for your enterprise. To view users that are assigned the administrator role, perform the following steps: Log on to the DMS console. In the top navigation bar, click O&M. In the left-side navigation pane, click User.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes RegisterUser

The operation that you want to perform. Set the value to RegisterUser.

Tid Long Yes -1

The ID of the tenant.

Note To query ID of the tenant, move the pointer over the profile picture in the upper-right corner of the DMS console. For more information, see the "View information about the current tenant" section of the Manage DMS tenants topic.
Uid Long Yes 12345678

The UID of the Alibaba Cloud account of the user that you want to register.
UserNick String No dmstest

The nickname of the user.
RoleNames String No USER,DBA

The role that you want to assign to the user. Valid values:

  • USER: a regular user role
  • DBA: a database administrator (DBA) role
  • ADMIN: a DMS administrator role
  • SECURITY_ADMIN: a security administrator role
Note If you do not specify this parameter, the regular user role is assigned to the user by default. You can assign one or more roles to the user. Separate multiple roles with commas (,).
Mobile String No 130000000xx

The mobile number of the user.

Response parameters

Parameter Type Example Description
ErrorCode String 403

The error code returned.
ErrorMessage String The specified user already exists.

The error message returned.
RequestId String 34E01EDD-6A16-4CF0-9541-C644D1BE01AA

The ID of the request.
Success Boolean true
  • true: The request was successful.
  • false: The request failed.

Examples

Sample requests

http(s)://[Endpoint]/?Action=RegisterUser
&Tid=-1
&Uid=12345678
&UserNick=dmstest
&<Common request parameters>

Sample success responses

XML format 

<RegisterUserResponse>
      <RequestId>ADE24A7C-DB8B-4D32-94AD-E50E3B921197</RequestId>
      <Success>true</Success>
</RegisterUserResponse>

JSON format 

{
    "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
    "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.