Class GroupsClient

Namespace

Auth0.ManagementApi.Roles

Assembly

Auth0.ManagementApi.dll

public class GroupsClient : IGroupsClient

Inheritance

object

GroupsClient

Implements

IGroupsClient

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

Assign one or more groups to a specified role.

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

Parameters

id string

request AssignRoleGroupsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

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

DeleteAsync(string, DeleteRoleGroupsRequestContent, RequestOptions?, CancellationToken)

Unassign one or more groups from a specified role.

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

Parameters

id string

request DeleteRoleGroupsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

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

GetAsync(string, ListRoleGroupsParameters, RequestOptions?, CancellationToken)

Lists the groups to which the specified role is assigned.

public Task<Pager<Group>> GetAsync(string id, ListRoleGroupsParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request ListRoleGroupsParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<Group>>

Examples

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