Cloud 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 Cloud Access Service .

For information about managing access to this API, see Accessing the Cloud Administration APIs.

Authentication

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.

Software Developer Kit

You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.

Request Requirements

Use the following information to set a user's status.

Example Request Data

The following example displays an enable user request.

PUT https://localhost/AdminInterface/restapi/v1/users/<id>/userStatus

Content-Type: application/json

Authorization: Bearer <JWT token>

{

"userStatus": "Enabled"

}

Request Parameters

The following table describes the request parameters.

Example 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.

{

"id": "f10d0514-7dd1-4a13-a30e-236d0e65b56a",

"userStatus": "Enabled"

Response Property Descriptions

The following table shows property descriptions and data types.

Response Codes

The following table shows response codes and descriptions for this API.