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.

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

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

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.

Response Codes

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