Cloud 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.

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 retrieve and disable a hardware token by providing a token serial number.

Example 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 Body

{

"tokenSerialNumber" : "1231314525"

}

Request Property Descriptions

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

Example 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 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.