Cloud Administration Unassign Hardware Token API
The Cloud Administration Unassign Hardware Token API enables Help Desk Administrators to unassign a single hardware token from a user.
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 a request. For instructions on using this token, see Authentication for the Cloud Administration REST 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 unassign a hardware token assigned to a user by providing a token serial number as the input.
| Method | Request URL | Response Content Type | Response Body | Response Codes |
|---|---|---|---|---|
| PATCH | /AdminInterface/restapi/v1/users/<userId>/sidTokens/unassign | application/json | Token details with property | 200, 400, 403, 404, 409, 429, 500 |
Example Request Data
The following example displays a hardware token unassignment request.
PATCH /AdminInterface/restapi/v1/users/<userId>/sidTokens/unassign
Content-Type: application/json
Authorization: Bearer <JWT token>
Example Request Body
{
"tokenSerialNumber" : "000123456789"
}
Request 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 Response
The following example response shows the state of a single hardware token that was unassigned from a user.
{
"tokenSerialNumber": "000123456789",
"tokenState": "Unassigned"
}
Response Property Descriptions
The following table shows response property descriptions and the associated data types.
| Property | Description | Data Type |
|---|---|---|
| tokenSerialNumber | Serial number of the hardware token. | String |
| tokenState | State of the hardware token: Unassigned, Activation Pending, or Activated. | String |
Response Codes
The following table shows response codes and descriptions for this API.
| Code | Description |
|---|---|
| 200 | The hardware token is successfully unassigned from the user. |
| 400 | Invalid parameters provided (such as invalid token serial number or user ID format). |
| 403 | User is not authorized to perform the request. (Possible causes: Lack of administrator rights or invalid JSON web token provided). |
| 404 | Either the user ID or the hardware token serial number does not exist. |
| 409 | The request has inconsistent or conflicting state preventing it from getting completed. (Possible causes: The hardware token is not assigned to a specific user or vice versa). |
| 429 | Too many requests. |
| 500 | The request cannot be completed due to an internal server error. |
Related Articles
Unassign a Token from a User in the User Dashboard Number of Views Unassign a Token from a User Number of Views Default token policy change prompts every user to change their PIN in RSA Authentication Manager 8.x Number of Views Maximum number of incorrect login attempts for RSA Authentication Manager Operations Console administrator Number of Views Assign a Hardware Token to a User Number of Views
Trending Articles
Quick Setup Guide - Passwordless Authentication in Windows MFA Agent for Active Directory RSA MFA Agent 2.5 for Microsoft Windows Installation and Administration Guide RSA MFA Agent 2.3.6 for Microsoft Windows Installation and Administration Guide How to Download OTP Token Seed Files from myRSA RSA Authentication Manager 8.9 Release Notes (January 2026)
