Changes the status of a user.

Usage notes

This topic provides an example on how to change the status of the user whose ID is u-00q8wbq42wiltcrk**** to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.

Limits

You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.

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 UpdateUserStatus

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

DirectoryId String Yes d-00fc2p61****

The ID of the directory.

UserId String Yes u-00q8wbq42wiltcrk****

The ID of the user.

NewStatus String No Disabled

The new status of the user. Valid values:

  • Enabled: The logon of the user is enabled.
  • Disabled: The logon of the user is disabled.

For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
RequestId String EE598602-AC67-56EF-B7CC-2927C30AA0A8

The ID of the request.

Examples

Sample requests

https://[Endpoint]/?Action=UpdateUserStatus
&DirectoryId=d-00fc2p61****
&UserId=u-00q8wbq42wiltcrk****
&NewStatus=Disabled
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<?xml version="1.0" encoding="UTF-8" ?>
<UpdateUserStatusResponse>
	<RequestId>EE598602-AC67-56EF-B7CC-2927C30AA0A8</RequestId>
</UpdateUserStatusResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "EE598602-AC67-56EF-B7CC-2927C30AA0A8"
}

Error codes

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