LoginRadius DocsDocs
DocumentationAPI ReferencesSDKsChangelogs

Delete Role

Deletes a Role by its ID.

DELETE
/v2/manage/roles/{id}

Deletes a Role by its ID.

Authorization

apikey<token>

Tenant API Key for authentication

In: query

apisecret<token>

Tenant API Secret for authentication

In: query

Path Parameters

id*string

Role ID

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://api.loginradius.com/v2/manage/roles/role_2enk23n3"
{
  "IsDeleted": true
}

{
  "ErrorCode": 8126,
  "Message": "Role id is required",
  "Description": "Role id is required, Please provide Role id."
}

{
  "ErrorCode": 8128,
  "Message": "Default Role cannot be deleted",
  "Description": "Default Role cannot be deleted, Please provide valid Role id."
}

{
  "ErrorCode": 8125,
  "Message": "Role does not exist",
  "Description": "Role does not exist, Please provide valid Role id."
}

{
  "Message": "Operation failed due to an internal error.",
  "Description": "An unknown internal error occurred, please try again in a few minutes or contact your system administrator.",
  "ErrorCode": 7909
}

Retrieve Role by ID GET

Retrieves details of a Role by its ID.

Update Role PUT

Updates a Role by its ID.