Edit Role Definitions

You can edit a role definition using the Auth0 Dashboard or the Management API. Roles are used with the API Authorization Core feature set.

Prerequisite

For role-based access control (RBAC) to work properly, you must enable it for your API using either the Dashboard or the Management API. The Authorization Core functionality is different from the Authorization Extension. For a comparison, read Authorization Core vs. Authorization Extension.

Dashboard

1. Go to Dashboard > User Management > Roles and click the name of the role to view.
2. Edit the role name and description, then click Save.

Management API

Make a PATCH call to the Update Role endpoint. Be sure to replace ROLE_ID, MGMT_API_ACCESS_TOKEN, ROLE_NAME, and ROLE_DESC placeholder values with your role ID, Management API access token, role name, and role description, respectively.

cURL

curl --request PATCH \
  --url 'https://{yourDomain}/api/v2/roles/ROLE_ID' \
  --header 'authorization: Bearer MGMT_API_ACCESS_TOKEN' \
  --header 'cache-control: no-cache' \
  --header 'content-type: application/json' \
  --data '{ "name": "ROLE_NAME", "description": "ROLE_DESC" }'

Value	Description
ROLE_ID	Τhe ID of the role for which you want to edit the definition.
MGMT_API_ACCESS_TOKEN	Access Token for the Management API with the scope update:roles.
ROLE_NAME	Name of the role.
ROLE_DESC	User-friendly description of the role.

Learn more

• Assign Roles to Users