Cloud Administration Disable Hardware Token APICloud Administration Disable Hardware Token API
The Cloud Administration Disable Hardware Token API allows Help Desk Administrators and Super Administrators to disable a hardware token that is assigned to a user.
When a token is disabled, it cannot be used for authentication.
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 retrieve and disable a hardware token by providing a token serial number.
| Method | Request URL | Response Content Type | Response Body | Response Codes |
|---|---|---|---|---|
| PATCH | /AdminInterface/restapi/v1/users/<userId>/sidTokens/disable | application/json | Token details with property | 200, 403, 404, 409, 500 |
Example Request DataExample Request Data
The following example displays a request.
PATCH /AdminInterface/restapi/v1/users/<userId>/sidTokens/disable
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 |
Example ResponseExample Response
The following example response shows the status of a single hardware token with the token serial number specified in the request.
{
"userId": "eb2e12ae-1112-451b-98e1-dfe4e6afd60d",
"tokenSerialNumber": "1231314525",
"tokenStatus": "Disabled",
"tokenStatusChangedBy": "<admin subject>",
"tokenStatusChangedAt": "<2021-06-11T19:10:30.045Z>"
}
Response Property DescriptionsResponse Property Descriptions
The following table shows response property descriptions and the associated data types.
| Property | Description | Data Type |
|---|---|---|
| userId | Identifies the user to whom the hardware token is assigned or registered. | String |
| tokenSerialNumber | Serial number of the hardware token. | String |
| tokenStatus | Status of the hardware token: Enabled or Disabled. | String |
| tokenStatusChangedBy | Identifies the administrator who enabled or disabled the hardware token. | String |
| tokenStatusChangedAt | The timestamp when the hardware token was enabled or disabled. For information on formatting timestamps in ISO 8601 format, see https://www.w3.org/TR/NOTE-datetime. | String |
Response CodesResponse Codes
The following table shows response codes and descriptions for this API.
| Code | Description |
|---|---|
| 200 | Successfully disabled hardware token assigned to a user. |
| 403 | Not authorized to perform the request. |
| 404 | Either the user or the hardware token does not exist. |
| 409 | Cannot disable a hardware token that is not assigned to a particular user. |
| 500 | Internal server error occurred while processing the request. |
| 429 | Too many requests. |
