Cloud Administration Disable SecurID DS100 OTP Credential API

The Cloud Administration Disable SecurID DS100 OTP Credential API allows Help Desk Administrators and Super Administrators to disable SecurID DS100 OTP credential. When a credential is disabled, it cannot be used for authentication.

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 OTP credential by providing the device serial number and user ID.

Method Request URL Response Content Type Response Body Response Codes
PATCH /AdminInterface/restapi/v1/ds100/disable/otp application/json OTP credential details with property 200, 400, 403, 404, 500


Example Request Data

The following example displays a request.

PATCH /AdminInterface/restapi/v1/ds100/disable/otp

Accept: application/json

Authorization: Bearer <JWT token>

Example Request Body

{

"deviceSerialNumber": "140100080",

"userId": "ece30fe9-414c-7536-5403-0656220b3046"

}

Request Property Descriptions

Property Description Data Type
deviceSerialNumber The serial number of the hardware authenticator. The number is displayed at the back of the SecurID DS100 authenticator. String
userId Identifies the user to whom the SecurID DS100 authenticator is registered. String

Example Response

The following example displays a response body.

[

{

"userId" : "ece30fe9-414c-7536-5403-0656220b3046",

"tokenSerialNumber": "014010008031",

"tokenStatus": "Disabled",

"tokenStatusChangedAt": "2022-05-24T084041.067Z",

"tokenStatusChangedBy": "<admin subject>",

"deviceSerialNumber": "140100080"

}

]

Response Property Descriptions

The following table shows response property descriptions and the associated data types.

Property Description Data Type
userId Identifies the user associated with this authenticator. String
tokenSerialNumber Serial number of the OTP credential. String
tokenStatus Status of the OTP credential: Enabled or Disabled. String
tokenStatusChangedAt The timestamp when the OTP credential was disabled. For information on formatting timestamps in ISO 8601 format, see https://www.w3.org/TR/NOTE-datetime. String
tokenStatusChangedBy Identifies the administrator who disabled the credential. String
deviceSerialNumber The serial number of the hardware authenticator. The number is displayed at the back of the SecurID DS100 authenticator. String

Response Codes

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

Code Description
200 Successfully disabled DS100 OTP credential assigned to the user.
400 Bad Request. Operation not performed because of client syntax errors.
403 Not authorized to perform the request.
404 Either the user or the SecurID DS100 authenticator does not exist
500 Internal server error occurred while processing the request.