You can call this operation to disable a user that is temporarily not used in Data Management (DMS) Enterprise.

The effect of disabling a user by calling this operation is the same as that of disabling a user by choosing System Management > User Management in the DMS Enterprise console. The administrator of DMS Enterprise can call this operation to disable a user that is temporarily not used in DMS Enterprise. After the user is disabled, the data source permission, data owner configuration, and database administrator (DBA) configuration of the corresponding Alibaba Cloud account or Resource Access Management (RAM) user are revoked and become invalid.

Note This operation only stops the Alibaba Cloud account or RAM user from logging on to DMS Enterprise of the enterprise, rather than actually disabling the Alibaba Cloud account or RAM user. After the user is disabled, the Alibaba Cloud account or RAM user cannot log on to DMS Enterprise, unless the user is enabled again. The disabled user, however, still exists in DMS Enterprise.

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 DisableUser

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

Tid Long Yes -1

The ID of the tenant.

Note To query the ID, log on to the DMS Enterprise console and choose System Management > Instance Management or System Management > User Management. The ID of the tenant appears in the Service Specification section.
Uid Long Yes 12345

The Alibaba Cloud unique ID (UID) of the user to disable.

Response parameters

Parameter Type Example Description
ErrorCode String 403

The error code.
ErrorMessage String The specified user does not exist.

The error message.
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=DisableUser
&Tid=-1
&Uid=12345
&<Common request parameters>

Sample success responses

XML format 

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

JSON format 

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

Error codes

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