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"
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.ListRolesRequestParameters{
        PerPage: management.Int(
            1,
        ),
        Page: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        NameFilter: management.String(
            "name_filter",
        ),
    }
    client.Roles.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.roles.requests.ListRolesRequestParameters;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .token("<token>")
            .build();

        client.roles().list(
            ListRolesRequestParameters
                .builder()
                .perPage(1)
                .page(1)
                .includeTotals(true)
                .nameFilter("name_filter")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Roles\Requests\ListRolesRequestParameters;

$client = new Management(
    token: '<token>',
);
$client->roles->list(
    new ListRolesRequestParameters([
        'perPage' => 1,
        'page' => 1,
        'includeTotals' => true,
        'nameFilter' => 'name_filter',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.roles.list(
    per_page=1,
    page=1,
    include_totals=True,
    name_filter="name_filter",
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.roles.list(
  per_page: 1,
  page: 1,
  include_totals: true,
  name_filter: "name_filter"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.roles.list({
        perPage: 1,
        page: 1,
        includeTotals: true,
        nameFilter: "name_filter",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.roles.list({
        perPage: 1,
        page: 1,
        includeTotals: true,
        nameFilter: "name_filter",
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/roles \
  --header 'Authorization: Bearer <token>'

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.