Get a role's 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.

GET https://{tenantDomain}/api/v2/roles/{id}/users

C#

C#

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

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

        await client.Roles.Users.ListAsync(
            id: "id",
            request: new ListRoleUsersRequestParameters {
                From = "from",
                Take = 1
            }
        );
    }

}

200

[
  {
    "user_id": "<string>",
    "picture": "<string>",
    "name": "<string>",
    "email": "[e-mail]"
  }
]

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

ID of the role to retrieve a list of users associated with.

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).

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100

Response

200

application/json

Role users successfully retrieved.

Option 1 · object[]

Option 2 · object

Option 3 · object

user_id · string

ID of this user.

picture · string

URL to a picture for this user.

name · string

Name of this user.

email · string<email> · default: [e-mail]

Email address of this user.