Class RolesClient

Namespace

Auth0.ManagementApi

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)

Properties

Permissions

public IPermissionsClient Permissions { get; }

Property Value

IPermissionsClient

Users

public IUsersClient Users { get; }

Property Value

IUsersClient

Methods

CreateAsync(CreateRoleRequestContent, RequestOptions?, CancellationToken)

Create a user role for Role-Based Access Control.

Note: New roles are not associated with any permissions by default. To assign existing permissions to your role, review Associate Permissions with a Role. To create new permissions, review Add API Permissions.

public WithRawResponseTask<CreateRoleResponseContent> CreateAsync(CreateRoleRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateRoleRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateRoleResponseContent>

Examples

await client.Roles.CreateAsync(new CreateRoleRequestContent { Name = "name" });

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete a specific user role from your tenant. Once deleted, it is removed from any user who was previously assigned that role. This action cannot be undone.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Roles.DeleteAsync("id");

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve details about a specific user role specified by ID.

public WithRawResponseTask<GetRoleResponseContent> GetAsync(string id, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetRoleResponseContent>

Examples

await client.Roles.GetAsync("id");

ListAsync(ListRolesRequestParameters, RequestOptions?, CancellationToken)

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.

public Task<Pager<Role>> ListAsync(ListRolesRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request ListRolesRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<Role>>

Examples

await client.Roles.ListAsync(
    new ListRolesRequestParameters
    {
        PerPage = 1,
        Page = 1,
        IncludeTotals = true,
        NameFilter = "name_filter",
    }
);

UpdateAsync(string, UpdateRoleRequestContent, RequestOptions?, CancellationToken)

Modify the details of a specific user role specified by ID.

public WithRawResponseTask<UpdateRoleResponseContent> UpdateAsync(string id, UpdateRoleRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request UpdateRoleRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateRoleResponseContent>

Examples

await client.Roles.UpdateAsync("id", new UpdateRoleRequestContent());