Cloud Administration Delete Hardware Token APICloud Administration Delete Hardware Token API
The Cloud Administration Delete Hardware Token API enables Help Desk Administrators to delete a hardware token record from the Cloud Authentication Service by providing a token serial number. After the record is successfully deleted, the user cannot authenticate with the token.
AuthenticationAuthentication
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.
Administrative RolesAdministrative Roles
This API can use an API key associated with either Super Administrator or Help Desk Administrator role. For more information, see Manage the Cloud Administration API Keys.
Software Developer KitSoftware Developer Kit
You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Request RequirementsRequest Requirements
Use the following information to delete a hardware token record by providing a token serial number.
| Method | Request URL | Response Content Type | Response Body | Response Codes |
|---|---|---|---|---|
| DELETE | /AdminInterface/restapi/v1/sidTokens/delete | application/json | Token details with property | 200, 403, 404, 500 |
Example Request DataExample Request Data
The following example displays a request.
DELETE /AdminInterface/restapi/v1/sidTokens/delete
Accept: application/json
Authorization: Bearer <JWT token>
Example Request BodyExample Request Body
{
"tokenSerialNumber" : "1231314525"
}
Request Property DescriptionsRequest Property Descriptions
The following table shows request property descriptions and other associated information.
| Property | Description | Required? | Max Length | Data Type |
|---|---|---|---|---|
| tokenSerialNumber | The token serial number associated with a user. The number is displayed at the back of the SecurID700 hardware token. | Yes | 36 | String |
Response CodesResponse Codes
The following table shows response codes and descriptions for this API.
| Code | Description |
|---|---|
| 200 | Successfully deleted a hardware token assigned to the user. |
| 403 | The Help Desk Administrator does not have the permission to delete SecurID700 hardware tokens. Only a Super Administrator can perform this task. |
| 404 | Hardware token with serial number is not found. |
| 500 | Internal error. The following message is returned: Unable to complete service call. |
