How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Auth0 roles API

The roles API from Auth0 — 4 operation(s) for roles.

Auth0 roles API is one of 76 APIs that Auth0 publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, authentication docs, and an AsyncAPI specification.

This API exposes 10 operations across 4 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{tenantDomain}/api/v2.

10 operations 4 paths 19 schemas 2 DELETE4 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://your-tenant.auth0.com/api/v2
Authentication
HTTP Bearer, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

Auth0 roles API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (jwt) (bearerAuth). It supports OAuth 2.0 (oAuth2ClientCredentials) using the clientCredentials flow, exposing 221 scopes. By default, every request must be authenticated.

Paths & Operations 10

Across 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

roles 10
GET
/roles
Get Roles
get_roles 4 params → 200400401403429
POST
/roles
Create a Role
post_roles body → 200400401403409429
GET
/roles/{id}
Get a Role
get_roles_by_id 1 param → 200400401403404429
DELETE
/roles/{id}
Delete a Role
delete_roles_by_id 1 param → 200400401403404429
PATCH
/roles/{id}
Update a Role
patch_roles_by_id 1 param body → 200400401403429
GET
/roles/{id}/permissions
Get Permissions Granted by Role
get_role_permission 4 params → 200400401403404429
DELETE
/roles/{id}/permissions
Remove Permissions from a Role
delete_role_permission_assignment 1 param body → 200400401403429
POST
/roles/{id}/permissions
Associate Permissions with a Role
post_role_permission_assignment 1 param body → 201400401403429
GET
/roles/{id}/users
Get a Role's Users
get_role_user 6 params → 200400401403404429
POST
/roles/{id}/users
Assign Users to a Role
post_role_users 1 param body → 200400401403404429

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are PermissionsResponsePayload (4 properties), RoleUser (4 properties), ListRolesOffsetPaginatedResponseContent (4 properties), ListRolePermissionsOffsetPaginatedResponseContent (4 properties). Each schema is shown below with its type and property counts.

DeleteRolePermissionsRequestContent
object
1 property 1 required
ListRolesResponseContent
UpdateRoleRequestContent
object
2 properties
CreateRoleResponseContent
object
3 properties
UpdateRoleResponseContent
object
3 properties
ListRoleUsersOffsetPaginatedResponseContent
object
4 properties
PermissionsResponsePayload
object
4 properties
GetRoleResponseContent
object
3 properties
PermissionRequestPayload
object
2 properties 2 required
ListRoleUsersResponseContent
AddRolePermissionsRequestContent
object
1 property 1 required
ListRolePermissionsOffsetPaginatedResponseContent
object
4 properties
ListRolesOffsetPaginatedResponseContent
object
4 properties
AssignRoleUsersRequestContent
object
1 property 1 required
RoleUser
object
4 properties
CreateRoleRequestContent
object
2 properties 1 required
Role
object
3 properties
ListRolePermissionsResponseContent
ListRoleUsersPaginatedResponseContent
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

auth0-roles-api-openapi.yml Raw ↑

Other APIs Auth0 publishes across the network.

Auth0 My Account API
Auth0 My Organization API
Auth0 for AI Agents
Auth0 actions API
Auth0 anomaly API
Auth0 Assertions API
Auth0 attack-protection API
Auth0 Authorization Models API
Auth0 Authorize User API
Auth0 AuthZenService API
Auth0 branding API
Auth0 client-grants API
Where this information came from

This is an independent, third-party profile of Auth0 roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.