Class UsersClient

Namespace

Auth0.ManagementApi.Roles

Assembly

Auth0.ManagementApi.dll

public class UsersClient : IUsersClient

Inheritance

object

UsersClient

Implements

IUsersClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Methods

AssignAsync(string, AssignRoleUsersRequestContent, RequestOptions?, CancellationToken)

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.

public Task AssignAsync(string id, AssignRoleUsersRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request AssignRoleUsersRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Roles.Users.AssignAsync(
    "id",
    new AssignRoleUsersRequestContent { Users = new List<string>() { "users" } }
);

ListAsync(string, ListRoleUsersRequestParameters, RequestOptions?, CancellationToken)

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.

public Task<Pager<RoleUser>> ListAsync(string id, ListRoleUsersRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request ListRoleUsersRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<RoleUser>>

Examples

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