Cloud Administration Unlock User Tokencodes API

Document created by RSA Information Design and Development on Nov 16, 2018Last modified by RSA Information Design and Development on May 17, 2019
Version 7Show Document
  • View in full screen mode

The Cloud Administration Unlock User Tokencodes API enables Help Desk administrators to unlock a user's Authenticate Tokencode, SMS Tokencode, and Voice Tokencode.

Note:  The client requests the Cloud Administration User Details API to retrieve the User ID before it sends a request to this API.

For more information, see Unlock All Tokencodes for a User.

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 in the request. The <userId> parameter is a unique user identifier that is sent in the response to the Cloud Administration User Details API .

                        
MethodRequest URL

Request Content Type

Response Content TypeResponse Codes
PATCH /AdminInterface/restapi/v1/users/
<userId>/methods
application/jsonapplication/json200, 400, 403, 404, 500

Example Request Data

The following example displays a request.

Regardless of which methods are specified in the request, the status of all methods after the unlock operation has completed is included in the response.

PATCH https://localhost/AdminInterface/restapi/v1/users/<userId>/methods

Content-Type: application/json

Authorization: Bearer <JWT token>

{

"unlockMethods" : ["TOKEN", "VOICE", "SMS"]

}

Request Parameter

The following table describes the unlockMethods parameter.

               
Request ParameterDescription
unlockMethodsSet property value to an array for methods SMS, TOKEN, and VOICE. You must set at least one property value.

Example Response Data

The following example displays a response.

Note:  Regardless of which methods are specified in the request, the status of all methods is included in the response after the unlock operation has completed.

{

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

"isTokenLocked": false,

"isSmsLocked": false,

"isVoiceLocked": false

}

Property Response Descriptions

The following table shows property descriptions and data types.

                                 
PropertyDescriptionData Type
userIdIdentifies the user.String
isTokenLockedToken locked status is either true (locked) or false (unlocked).Boolean
isSmsLockedSMS phone locked status is either true (locked) or false (unlocked).Boolean
isVoiceLockedVoice locked status is either true (locked) or false (unlocked).Boolean

Response Codes

The Cloud Authentication Service returns the following response codes.

                               
CodeDescription
200Unlock is successful.
400Invalid User ID or request body.
403Not authorized to perform the request.
404User is not found.
500Internal error occurred when processing the request. All methods are not unlocked.

Note:  For codes 200 and 500, the response body provides the lock status of all method types after the lock was attempted.

 

 

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

Attachments

    Outcomes