Cloud Administration User Status APICloud Administration User Status API
Use the Cloud Administration User Status API to update a user's status from Disabled to Enabled or from Enabled to Disabled. For more information on user status, see Manage Users for the Cloud Authentication Service.
Clients calling this API must authenticate themselves by including a JSON Web Token in a request. For instructions on using this token, see Authentication for the Cloud Administration REST APIs.
Administrative RolesAdministrative Roles
This API can use an API key that is associated with either the Super Administrator or Help Desk Administrator role. For more information, see Manage the Cloud Administration REST API Keys.
Software Developer KitSoftware Developer Kit
You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Request RequirementsRequest Requirements
Use the following information to set a user's status.
|Method||Request URL||Response Content Type||Response Body||Response Codes|
|application/json||User status||200, 400, 403, 404, 409, 500|
Example Request DataExample Request Data
The following example displays an enable user request.
Authorization: Bearer <JWT token>
Request ParametersRequest Parameters
The following table describes the request parameters.
|Request Parameters||Description||Data Type|
|userId||Unique user identifier that can be retrieved by calling the Cloud Administration User Details API .||String|
Current user status includes the following values:
Example Response DataExample Response Data
The following example provides the User ID specified in the request and the user's status after the status change operation is completed.
Response Property DescriptionsResponse Property Descriptions
The following table shows property descriptions and data types.
|id||Unique User ID.||String|
|userStatus||User's status after the status change operation is completed.||String|
Response CodesResponse Codes
The following table shows response codes and descriptions for this API.
|200||User successfully enabled or disabled.|
|400||User status not provided in the request body. Value of user status is not equal to Enabled or Disabled.|
|403||Not authorized to perform the request (expired JWT).|
|404||User is not found. (Includes invalid User ID and blank or empty User ID).|
Attempted to enable a user who is already in pending delete state.
Attempted to enable a user who was previously disabled by a synchronization operation.
|500||Internal error occurred when processing the request.|