(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:

NameDescriptionTypeRequiredExample values
idid of the desired record to deleteLongYes7

URL with external_id:

https://BASE_URL/api/VERSION/userAuthorities/reference/{userId}/{authorityId}

Parameters:

NameDescriptionTypeRequiredExamples values
userIdreference of the userStringYesU-002
authorityIdname of the authorityStringYesCEO

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..."
}