Delete Activation Codes
Deletes all the activation codes for the given userId. This could be used to delete obsolete or multiple activation codes for a user. To create an activation code, use Create Activation Code.
Resource Informations
| Name | Value |
|---|---|
| Requires authentication? | Yes |
| Rate limited? | No |
Request
Request headers
| Key | Value |
|---|---|
| Authorization | Bearer token |
| Content-Type | application/json |
HTTP request URL for SSMS
DELETE https://{tenantId}.{hostname}/digitanium/v4/users/{userName}/activationcodes
HTTP request URL for SHIFT
DELETE https://{hostname}/auth/realms/{tenantId}/v3_activationcode/{userName}
note
At this moment, this API is applicable only for SSMS based installations.
note
API requests must be made over https. Calls made over plain http will fail.
Parameters
No parameter fields are required.
Request body
No request body fields are required.
Response
| Field Name | Type | Description |
|---|---|---|
| message | String | Message explains result of the API call. Refer Response status Information for details. |
| status | String | The status of the API call. Refer Response status Information for details. |
| subSystem | Integer | subSystem categorizes the type of API that has been called. Refer Subsystem details for details. |
| data | Boolean | true - when codes are deleted and false - when codes are already deleted. |
Sample Response
{
"subSystem": 5,
"status": "OK",
"message": "Activation codes deleted successfully",
"data": true
}
Response Status Information
| Status Code | Status | Message |
|---|---|---|
| 200 | OK | Activation codes deleted successfully |
| 401 | Unauthorized | HTTP 401 Unauthorized |
| 404 | USER_NOT_FOUND | User does not exist |