Delete User
Delete User API is used to delete a user, which was created using Create User.
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}
HTTP request URL for SHIFT
DELETE https://{hostname}/auth/realms/{tenantId}/v3_user/{userName}
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. |
Sample Response
{
"message": "User deleted successfully",
"status": "OK",
"subSystem": 5
}
Response Status Information
Status Code | Status | Message |
---|---|---|
200 | OK | User deleted successfully |
401 | Unauthorized | HTTP 401 Unauthorized |
404 | USER_NOT_FOUND | User does not exist |