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 https://{tenantDomain}/api/v2/roles

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Roles.ListAsync(
            new ListRolesRequestParameters {
                PerPage = 1,
                Page = 1,
                IncludeTotals = true,
                NameFilter = "name_filter"
            }
        );
    }

}

200

[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>"
  }
]

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page · integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

page · integer

Page index of the results to return. First page is 0.

Required range: x >= 0

include_totals · boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

name_filter · string

Optional filter on name (case-insensitive).

Response

200

application/json

Roles successfully retrieved.

object[]

object

id · string

ID for this role.

name · string

Name of this role.

description · string

Description of this role.