Class RolesClient

Namespace

Auth0.ManagementApi.Organizations.Members

Assembly

Auth0.ManagementApi.dll

public class RolesClient : IRolesClient

Inheritance

object

RolesClient

Implements

IRolesClient

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, string, AssignOrganizationMemberRolesRequestContent, RequestOptions?, CancellationToken)

Assign one or more roles to a user to determine their access for a specific Organization.

Users can be members of multiple Organizations with unique roles assigned for each membership. This action assigns roles to a user only for the specified Organization. Roles cannot be assigned to a user across multiple Organizations in the same call.

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

Parameters

id string

userId string

request AssignOrganizationMemberRolesRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Organizations.Members.Roles.AssignAsync(
    "id",
    "user_id",
    new AssignOrganizationMemberRolesRequestContent { Roles = new List<string>() { "roles" } }
);

DeleteAsync(string, string, DeleteOrganizationMemberRolesRequestContent, RequestOptions?, CancellationToken)

Remove one or more Organization-specific roles from a given user.

Users can be members of multiple Organizations with unique roles assigned for each membership. This action removes roles from a user in relation to the specified Organization. Roles assigned to the user within a different Organization cannot be managed in the same call.

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

Parameters

id string

userId string

request DeleteOrganizationMemberRolesRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Organizations.Members.Roles.DeleteAsync(
    "id",
    "user_id",
    new DeleteOrganizationMemberRolesRequestContent { Roles = new List<string>() { "roles" } }
);

ListAsync(string, string, ListOrganizationMemberRolesRequestParameters, RequestOptions?, CancellationToken)

Retrieve detailed list of roles assigned to a given user within the context of a specific Organization.

Users can be members of multiple Organizations with unique roles assigned for each membership. This action only returns the roles associated with the specified Organization; any roles assigned to the user within other Organizations are not included.

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

Parameters

id string

userId string

request ListOrganizationMemberRolesRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<Role>>

Examples

await client.Organizations.Members.Roles.ListAsync(
    "id",
    "user_id",
    new ListOrganizationMemberRolesRequestParameters
    {
        Page = 1,
        PerPage = 1,
        IncludeTotals = true,
    }
);