Class MembersClient

Namespace

Auth0.ManagementApi.Organizations

Assembly

Auth0.ManagementApi.dll

public class MembersClient : IMembersClient

Inheritance

object

MembersClient

Implements

IMembersClient

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)

Properties

Roles

public IRolesClient Roles { get; }

Property Value

IRolesClient

Methods

CreateAsync(string, CreateOrganizationMemberRequestContent, RequestOptions?, CancellationToken)

Set one or more existing users as members of a specific Organization.

To add a user to an Organization through this action, the user must already exist in your tenant. If a user does not yet exist, you can invite them to create an account, manually create them through the Auth0 Dashboard, or use the Management API.

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

Parameters

id string

request CreateOrganizationMemberRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Organizations.Members.CreateAsync(
    "id",
    new CreateOrganizationMemberRequestContent { Members = new List<string>() { "members" } }
);

DeleteAsync(string, DeleteOrganizationMembersRequestContent, RequestOptions?, CancellationToken)

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

Parameters

id string

request DeleteOrganizationMembersRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Organizations.Members.DeleteAsync(
    "id",
    new DeleteOrganizationMembersRequestContent { Members = new List<string>() { "members" } }
);

ListAsync(string, ListOrganizationMembersRequestParameters, RequestOptions?, CancellationToken)

List organization members. This endpoint is subject to eventual consistency. New users may not be immediately included in the response and deleted users may not be immediately removed from it.

• Use the fields parameter to optionally define the specific member details retrieved. If fields is left blank, all fields (except roles) are returned.
• Member roles are not sent by default. Use fields=roles to retrieve the roles assigned to each listed member. To use this parameter, you must include the read:organization_member_roles scope in the token.

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, you should omit the from parameter. If there are more results, a next value will be included in the response. You can use this for subsequent API calls. When next is no longer included in the response, this indicates there are no more pages remaining.

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

Parameters

id string

request ListOrganizationMembersRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<OrganizationMember>>

Examples

await client.Organizations.Members.ListAsync(
    "id",
    new ListOrganizationMembersRequestParameters
    {
        From = "from",
        Take = 1,
        Fields = "fields",
        IncludeFields = true,
    }
);