DisableUser - Data Management - Alibaba Cloud Documentation Center

Disables a user that is temporarily not used in Data Management (DMS).

Operation description

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
Tid	long	Yes	The ID of the tenant. You can call the GetUserActiveTenant or ListUserTenants operation to obtain the tenant ID.	-1
Uid	string	Yes	The UID of the Alibaba Cloud account.	12345

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	34E01EDD-6A16-4CF0-9541-C644D1BE01AA
ErrorCode	string	The error code returned if the request fails.	403
ErrorMessage	string	The error message returned if the request fails.	The specified user not exists.
Success	boolean	Indicates whether the request is successful. Valid values: true: The request is successful. false: The request fails.	true

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation

No change history