Class GroupsClient

Namespace

Auth0.ManagementApi

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)

Properties

Members

public IMembersClient Members { get; }

Property Value

IMembersClient

Methods

DeleteAsync(string, RequestOptions?, CancellationToken)

Delete a group by its ID.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

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

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve a group by its ID.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetGroupResponseContent>

Examples

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

ListAsync(ListGroupsRequestParameters, RequestOptions?, CancellationToken)

List all groups in your tenant.

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

Parameters

request ListGroupsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<Group>>

Examples

await client.Groups.ListAsync(
    new ListGroupsRequestParameters
    {
        ConnectionId = "connection_id",
        Name = "name",
        ExternalId = "external_id",
        Fields = "fields",
        IncludeFields = true,
        From = "from",
        Take = 1,
    }
);