Skip to main content

Delete User

Delete User API is used to delete a user, which was created using Create User.

Resource Informations

NameValue
Requires authentication?Yes
Rate limited?No

Request

Request headers

KeyValue
AuthorizationBearer token
Content-Typeapplication/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 NameTypeDescription
messageStringMessage explains result of the API call. Refer Response status Information for details.
statusStringThe status of the API call. Refer Response status Information for details.
subSystemIntegersubSystem 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 CodeStatusMessage
200OKUser deleted successfully
401UnauthorizedHTTP 401 Unauthorized
404USER_NOT_FOUNDUser does not exist