Cloud Administration Clear PIN SecurID DS100 OTP Credential APICloud Administration Clear PIN SecurID DS100 OTP Credential API
The Cloud Administration Clear PIN for SecurID DS100 OTP Credential API enables Help Desk Administrators or Super Administrator to clear the PIN for an OTP credential of SecurID DS100 authenticator assigned to a user.
AuthenticationAuthentication
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 APIs .
Administrative RolesAdministrative Roles
This API can use an API key that is associated with either the 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 clear the OTP credential PIN.
Method | Request URL | Response Content Type | Response Body | Response Codes |
---|---|---|---|---|
PATCH | /AdminInterface/restapi/v1/ds100/clearPin/otp | application/json | OTP credential PIN status | 200, 400, 403, 404, 500 |
Example Request DataExample Request Data
The following example displays a request.
PATCH /AdminInterface/restapi/v1/ds100/clearPin/otp
Accept: application/json
Authorization: Bearer <JWT Token>
Example Request BodyExample Request Body
{
"tokenSerialNumber": "014010008039",
"userId" : "87927fb7-e185-4c33-c7e3-8e077675973c"
}
Request Property DescriptionsRequest Property Descriptions
Property | Description | Data Type |
---|---|---|
toeknSerialNumber | The serial number of the OTP credential. The credential serial number can be obtained using Retrieve SecurID DS100 OTP Credential API. | String |
userId | Identifies the user associated with this authenticator. | String |
Example ResponseExample Response
{
"tokenSerialNumber":"014010008038"
"pinSet": false
}
Response Property DescriptionsResponse Property Descriptions
Property | Description | Data Type |
---|---|---|
tokenSerialNumber | The serial number of the OTP credential. | 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 CodesResponse Codes
The following table shows response codes and descriptions for this API.
Code | Description |
---|---|
200 | Successfully cleared the PIN for the OTP credential for SecurID DS100 authenticator assigned to the user. |
400 | Bad Request. Operation not performed because of client syntax errors. |
403 | Not authorized to perform the request. |
404 | Either the user or the SecurID DS100 token does not exist. |
500 | Internal server error occurred while processing the request. |
429 | Too many requests. |