All Products
Search
Document Center

Data Management:RegisterUser

Last Updated:Apr 26, 2024

Adds a user of your enterprise.

Operation description

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:RegisterUserRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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.
-1
UidstringYes

The UID of the Alibaba Cloud account of the user that you want to register.

12345678
UserNickstringNo

The nickname of the user.

dmstest
RoleNamesstringNo

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 (,).
USER,DBA
MobilestringNo

The mobile number of the user.

130000000xx

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

34E01EDD-6A16-4CF0-9541-C644D1BE01AA
ErrorCodestring

The error code returned.

403
ErrorMessagestring

The error message returned.

The specified user already exists.
Successboolean
  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "RequestId": "34E01EDD-6A16-4CF0-9541-C644D1BE01AA",
  "ErrorCode": "403",
  "ErrorMessage": "The specified user already exists.",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history