Revoke Roles
Using this API client and realm roles will be revoked from the user's.
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/{userid}/role
HTTP request URL for SHIFT
DELETE https://{hostname}/auth/realms/{tenantId}/v3_user/{userid}/role
note
API requests must be made over https. Calls made over plain http will fail.
Parameters
No parameter fields are required
Request body (Optional)
Field Name | Type | Description |
---|---|---|
ClientRoles | List | Configure the client roles for which the actions need to be performed by the user. Note: Using the composite role suffice in the request body, which gets all the sub roles available for it. |
realmRoles | List | Configure the realm roles for which the actions need to be performed by the user. |
{
"clientRoles": {
"client_Name": ["client_role1", "client_role2", "client_role3", "client_role4"]
},
"realmRoles": ["realm_role1", "realm_role2"]
}
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 roles revoked successfully",
"status": "OK",
"subSystem": 5
}
Response Status Information
Status Code | Status | Message |
---|---|---|
200 | OK | User roles revoked successfully |
400 | BAD_REQUEST | UserId should not be null or empty |
401 | Unauthorized | HTTP 401 Unauthorized |
404 | USER_NOT_FOUND | User does not exist |