(Quick Reference)
Service: Dissociate a user from an authority (role)
Description: This web service is used to dissociate an assigned user to a role and delete it.
Method: DELETE
URL:
https://BASE_URL/api/VERSION/userAuthorities/{id}
Parameters:
Name | Description | Type | Required | Example values |
---|
id | id of the desired record to delete | Long | Yes | 7 |
URL with external_id:
https://BASE_URL/api/VERSION/userAuthorities/reference/{userId}/{authorityId}
Parameters:
Name | Description | Type | Required | Examples values |
---|
userId | reference of the user | String | Yes | U-002 |
authorityId | name of the authority | String | Yes | CEO |
Success Output
Success case: response.status = 200
{
"success": "true",
"success_description": "Instance deleted successfully"
}
Failure Output
Failure case:response.status = 400
{
"error":"invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
}
{
"error": "delete_failed",
"error_description": "Failed to delete instance."
}
Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The user authority with the id 35 doesn't exist."
}
Failure case:response.status = 500
{
"error": "server_error",
"error_description": "Oops! Something went wrong..."
}