Cloud Administration Clear PIN for Hardware Token API
The Cloud Administration Clear PIN for Hardware Token API enables Help Desk Administrators to clear the PIN for a hardware token assigned to 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 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 a hardware token and clear the PIN.
| Method | Request URL | Response Content Type | Response Body | Response Codes |
|---|---|---|---|---|
| PATCH | /AdminInterface/restapi/v2/users/<userId>/sidTokens/clearPin | application/json | Token details with property | 200, 404, 409, 429, 500 |
Example Request Data
The following example displays a request.
PATCH /AdminInterface/restapi/v2/users/<userId>/sidTokens/clearPin
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.
| 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 whether the PIN is cleared or not for a single hardware token, with token serial number specified in the request.
{
"userId": "eb2e12ae-1112-451b-98e1-dfe4e6afd60d",
"tokenSerialNumber": "1231314525",
"pinSet": "false"
}
Response 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 |
| pinSet | Flag that tells the system whether the user has set a PIN or not. This is managed by the system and is mainly for informational purposes. Possible values: True - PIN is set. False - PIN is not set. | Boolean |
Response Codes
The following table shows response codes and descriptions for this API.
| Code | Description |
|---|---|
| 200 | Successfully cleared the PIN for the hardware token assigned to the user. |
| 404 | Either user does not exist or hardware token does not exist in Cloud Access Service (CAS). |
| 409 | Cannot clear the PIN for a hardware token because it is not assigned to a particular user. |
| 429 | Too many requests. |
| 500 | Internal server error occurred. The following message is returned: Unable to Enable/Disable a hardware token. |
Related Articles
Cloud Administration Retrieve Hardware Token Details API Number of Views Set User Expectations for Device Registration and Authentication Number of Views How to transfer an existing RSA SecurID token PIN to a replacement token in RSA Authentication Manager 8.x Number of Views Cloud Administration Delete Hardware Token API Number of Views RSA MFA Agent 3.0 for Microsoft AD FS Group Policy Object Template Guide (French) Number of Views
Trending Articles
RSA Authentication Manager Upgrade Process RSA Release Notes for RSA Authentication Manager 8.8 RSA RADIUS Server service failed to start in the RSA Authentication Manager 8.1 Operations Console Microsoft Entra ID External MFA - Relying Party Configuration Using OIDC - RSA Ready Implementation Guide RSA Release Notes: Cloud Access Service and RSA Authenticators
