Cloud Administration Disable Emergency Tokencode API

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. This action removes all Emergency Tokencodes associated with the user from the Cloud Authentication Service. After the tokencode is disabled:

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

  • The user can continue to use Emergency Tokencode offline to sign into a computer that is protected by the RSA MFA Agent for Microsoft Windows until the tokencode expires.

  • 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 REST 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 REST 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.

Method Request URL Response Content Type Response Codes
DELETE

/AdminInterface/restapi/v1/users/<userId>/emergencyTokencodes

 application/json 200

Request Parameters

The request requires the following parameters.

Method Description
<userId> Unique user identifier that is sent in response to the Cloud Administration User Details API.

Response Codes

This API returns the following response codes.

Code Description
200

Emergency Tokencode successfully disabled.
429 Too many requests.