Cloud Administration User Status API

Document created by RSA Information Design and Development on Jan 18, 2019Last modified by RSA Information Design and Development on May 17, 2019
Version 6Show Document
  • View in full screen mode

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

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

Administrative 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 API Keys.

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.

                        
MethodRequest URLResponse Content TypeResponse BodyResponse Codes
PUT /AdminInterface/restapi/v1/users/
<userId>/userStatus
application/jsonUser status200, 400, 403, 404, 409, 500

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.

                       
Request ParametersDescriptionData Type
userIdUnique user identifier that can be retrieved by calling the Cloud Administration User Details API .String
userStatus

Current user status includes the following values:

  • Enabled - Enables a user.
  • Disabled - Disables a user.
String

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"

}

Property Response Descriptions

The following table shows property descriptions and data types.

                       
PropertyDescriptionData Type
idUnique User ID.String
userStatusUser's status after the status change operation is completed.String

Response Codes

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

                                   
CodeDescription
200User successfully enabled or disabled.
400User status not provided in the request body. Value of user status is not equal to Enabled or Disabled.
403Not authorized to perform the request (expired JWT).
404User is not found. (Includes invalid User ID and blank or empty User ID).
409

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.

500Internal error occurred when processing the request.

 

 

You are here
Table of Contents > Cloud Administration APIs > Cloud Administration User Status API

Attachments

    Outcomes