Cloud Administration Disable Emergency Tokencode API

Document created by RSA Information Design and Development Employee on Oct 8, 2019Last modified by RSA Information Design and Development Employee on Jul 27, 2020
Version 12Show Document
  • View in full screen mode

Use the Cloud Administration Emergency Tokencode API to disable the Emergency Tokencode authentication method for a user. An administrator can disable a user's emergency tokencode before it expires. After the tokencode is disabled:

  • The user cannot select Emergency Tokencode during online authentication because it is not presented as an option.

  • The administrator cannot view or re-enable the tokencode. If the user needs emergency access, the administrator must generate a new tokencode.

For more information about Emergency Tokencode, see Supported Authentication Methods - Emergency Tokencode.

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 disable emergency tokencode for a user.

                     
MethodRequest URLResponse Content TypeResponse Codes
DELETE

/AdminInterface/restapi/v1/users/<userId>/emergencyTokencode/<emergencyTokencodeId>

application/json200

Request Parameters

The request requires the following parameters.

                   
MethodDescription
<userId>Unique user identifier that is sent in response to the Cloud Administration User Details API .
<emergencyTokencodeId>String that identifies the Emergency Tokencode.

Response Codes

This API returns the following response codes.

               
CodeDescription
200

Emergency Tokencode successfully disabled.

 

 

 

 

You are here
Table of Contents > Cloud Administration APIs > Cloud Administration Disable Emergency Tokencode API

Attachments

    Outcomes