Class ClientsClient

Namespace

Auth0.ManagementApi.Organizations

Assembly

Auth0.ManagementApi.dll

public class ClientsClient : IClientsClient

Inheritance

object

ClientsClient

Implements

IClientsClient

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

Associate one or more clients with an organization.

public WithRawResponseTask<IEnumerable<OrganizationClient>> CreateAsync(string id, CreateOrganizationClientsRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request CreateOrganizationClientsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<IEnumerable<OrganizationClient>>

Examples

await client.Organizations.Clients.CreateAsync(
    "id",
    new CreateOrganizationClientsRequestContent
    {
        Clients = new List<CreateOrganizationClientRequestItem>()
        {
            new CreateOrganizationClientRequestItem
            {
                ClientId = "client_id",
                UseForMemberAccess = true,
            },
        },
    }
);

DeleteAsync(string, DeleteOrganizationClientsRequestContent, RequestOptions?, CancellationToken)

Remove one or more client associations from an organization.

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

Parameters

id string

request DeleteOrganizationClientsRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask

Examples

await client.Organizations.Clients.DeleteAsync(
    "id",
    new DeleteOrganizationClientsRequestContent { Clients = new List<string>() { "clients" } }
);

GetAsync(string, string, RequestOptions?, CancellationToken)

Get a specific client association for an organization.

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

Parameters

id string

clientId string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetOrganizationClientResponseContent>

Examples

await client.Organizations.Clients.GetAsync("id", "client_id");

ListAsync(string, ListOrganizationClientsRequestParameters, RequestOptions?, CancellationToken)

List all clients associated with an organization, using checkpoint pagination.

• Note: The first time you call this endpoint, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no further results are remaining.

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

Parameters

id string

request ListOrganizationClientsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<OrganizationClient>>

Examples

await client.Organizations.Clients.ListAsync(
    "id",
    new ListOrganizationClientsRequestParameters { From = "from", Take = 1 }
);

UpdateAsync(string, string, UpdateOrganizationClientRequestContent, RequestOptions?, CancellationToken)

Update an organization client association.

public WithRawResponseTask<UpdateOrganizationClientResponseContent> UpdateAsync(string id, string clientId, UpdateOrganizationClientRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

clientId string

request UpdateOrganizationClientRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateOrganizationClientResponseContent>

Examples

await client.Organizations.Clients.UpdateAsync(
    "id",
    "client_id",
    new UpdateOrganizationClientRequestContent()
);