Auth0 API

Roles

roles

Methods

Create A Role -> { id, description, name }
post/roles

Create a user role for Role-Based Access Control.

Note: New roles are not associated with any permissions by default. To assign existing permissions to your role, review Associate Permissions with a Role. To create new permissions, review Add API Permissions.

Delete A Role ->
delete/roles/{id}

Delete a specific user role from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone.

Get Roles -> RolesPageNumberPage<{ id, description, name }>
get/roles

Retrieve detailed list of user roles created in your tenant.

Note: The returned list does not include standard roles available for tenant members, such as Admin or Support Access.

Get A Role -> { id, description, name }
get/roles/{id}

Retrieve details about a specific user role specified by ID.

Update A Role -> { id, description, name }
patch/roles/{id}

Modify the details of a specific user role specified by ID.

Roles

Permissions

roles.permissions

Methods

Associate Permissions With A Role ->
post/roles/{id}/permissions

Add one or more permissions to a specified user role.

Remove Permissions From A Role ->
delete/roles/{id}/permissions

Remove one or more permissions from a specified user role.

Get Permissions Granted By Role -> RolesPermissionsPageNumberPage<{ description, permission_name, resource_server_identifier, 1 more... }>
get/roles/{id}/permissions

Retrieve detailed list (name, description, resource server) of permissions granted by a specified user role.

Roles

Users

roles.users

Methods

Assign Users To A Role ->
post/roles/{id}/users

Assign one or more users to an existing user role. To learn more, review Role-Based Access Control.

Note: New roles cannot be created through this action.

Get A Role S Users -> UsersPageNumberPage<{ email, name, picture, 1 more... }>
get/roles/{id}/users

Retrieve list of users associated with a specific role. For Dashboard instructions, review View Users Assigned to Roles.

This endpoint supports two types of pagination:

  • Offset pagination
  • Checkpoint pagination

Checkpoint pagination must be used if you need to retrieve more than 1000 organization members.

Checkpoint Pagination

To search by checkpoint, use the following parameters:

  • from: Optional id from which to start selection.
  • take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.

Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.