Cloud Administration Unlock User Tokencodes API

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

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

For more information on unlocking tokencodes, 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 in the request. The <userId> parameter is a unique user identifier that is sent in the response to the User Details API.

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.

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

}

Response Property Descriptions

The following table shows property descriptions and data types.

Response Codes

The Cloud Access Service returns the following response codes.

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