Cloud Administration Delete Hardware Token API
8 months ago

Cloud Administration Delete Hardware Token API

The Cloud Administration Delete Hardware Token API enables Help Desk Administrators to delete a hardware token record from Cloud Access Service (CAS) by providing a token serial number. After the record is successfully deleted, the user cannot authenticate with the token.

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 the 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 delete a hardware token record by providing a token serial number.

MethodRequest URLResponse Content TypeResponse BodyResponse Codes
DELETE/AdminInterface/restapi/v1/sidTokens/deleteapplication/jsonToken details with property200, 403, 404, 429, 500

Example Request Data

The following example displays a request.

DELETE /AdminInterface/restapi/v1/sidTokens/delete

Accept: application/json

Authorization: Bearer <JWT token>

Example Request Body

{

"tokenSerialNumber" : "1231314525"

}

Request Property Descriptions

The following table shows request property descriptions and other associated information.

PropertyDescriptionRequired?Max LengthData Type
tokenSerialNumberThe token serial number associated with a user. The number is displayed at the back of the SecurID700 hardware token.Yes36String

Response Codes

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

CodeDescription
200Successfully deleted a hardware token assigned to the user.
403The Help Desk Administrator does not have the permission to delete SecurID700 hardware tokens. Only a Super Administrator can perform this task.
404Hardware token with serial number is not found.
429Too many requests.
500Internal error. The following message is returned: Unable to complete service call.