Cloud Administration Delete SecurID DS100 OTP Credential API

The Cloud Administration Delete SecurID DS100 OTP credential API allows Help Desk Administrators and Super Administrators to delete OTP credential of SecurID DS100 authenticator. After the credential is successfully deleted, the user cannot authenticate with the credential.

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 delete an OTP credential by providing credential and device serial number.

Method Request URL Response Content Type Response Body Response Codes
DELETE /AdminInterface/restapi/v1/ds100/delete/otp application/json Not Applicable 200, 400, 403, 404, 500

Example Request Data

The following example displays a request.

DELETE /AdminInterface/restapi/v1/ds100/delete/otp

Accept: application/json

Authorization: Bearer <JWT token>

Example Request Body

{

"tokenSerialNumber": "014010008038",

"deviceSerialNumber": "140100080",

"userId" : "87927fb7-e185-4c33-c7e3-8e077675973c"

}

Request Property Descriptions

Property Description Data Type
tokenSerialNumber The serial number of the OTP credential. The credential serial number can be obtained using Retrieve SecurID DS100 OTP credential API. String
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 associated with this authenticator. String

Response Codes

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

Code Description
200 Successfully deleted OTP credential for SecurID DS100 authenticator 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.