Class RolesClient

Namespace

Auth0.ManagementApi.Groups

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

CreateAsync(string, CreateGroupRolesRequestParameters, RequestOptions?, CancellationToken)

Assign one or more roles to a specified group.

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

Parameters

id string

request CreateGroupRolesRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Groups.Roles.CreateAsync(
    "id",
    new CreateGroupRolesRequestParameters { Roles = new List<string>() { "roles" } }
);

DeleteAsync(string, DeleteGroupRolesRequestContent, RequestOptions?, CancellationToken)

Unassign one or more roles from a specified group.

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

Parameters

id string

request DeleteGroupRolesRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Groups.Roles.DeleteAsync(
    "id",
    new DeleteGroupRolesRequestContent { Roles = new List<string>() { "roles" } }
);

ListAsync(string, ListGroupRolesRequestParameters, RequestOptions?, CancellationToken)

Lists the roles assigned to a group.

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

Parameters

id string

request ListGroupRolesRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<Role>>

Examples

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