Table of Contents

Interface IRolesClient

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll
public interface IRolesClient
Extension Methods

Properties

Permissions 

IPermissionsClient Permissions { get; }

Property Value

IPermissionsClient

Users 

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.

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

Parameters

request CreateRoleRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateRoleResponseContent>

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.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

Task

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve details about a specific user role specified by ID.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetRoleResponseContent>

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.

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

Parameters

request ListRolesRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task<Pager<Role>>

UpdateAsync(string, UpdateRoleRequestContent, RequestOptions?, CancellationToken)

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

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>