Class OrganizationsClient

Namespace

Auth0.ManagementApi

Assembly

Auth0.ManagementApi.dll

public class OrganizationsClient : IOrganizationsClient

Inheritance

object

OrganizationsClient

Implements

IOrganizationsClient

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

ClientGrants

public IClientGrantsClient ClientGrants { get; }

Property Value

IClientGrantsClient

DiscoveryDomains

public IDiscoveryDomainsClient DiscoveryDomains { get; }

Property Value

IDiscoveryDomainsClient

EnabledConnections

public IEnabledConnectionsClient EnabledConnections { get; }

Property Value

IEnabledConnectionsClient

Invitations

public IInvitationsClient Invitations { get; }

Property Value

IInvitationsClient

Members

public IMembersClient Members { get; }

Property Value

IMembersClient

Methods

CreateAsync(CreateOrganizationRequestContent, RequestOptions?, CancellationToken)

Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.

public WithRawResponseTask<CreateOrganizationResponseContent> CreateAsync(CreateOrganizationRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request CreateOrganizationRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateOrganizationResponseContent>

Examples

await client.Organizations.CreateAsync(new CreateOrganizationRequestContent { Name = "name" });

DeleteAsync(string, RequestOptions?, CancellationToken)

Remove an Organization from your tenant. This action cannot be undone.

Note: Members are automatically disassociated from an Organization when it is deleted. However, this action does not delete these users from your tenant.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

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

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve details about a single Organization specified by ID.

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

Parameters

id string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetOrganizationResponseContent>

Examples

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

GetByNameAsync(string, RequestOptions?, CancellationToken)

Retrieve details about a single Organization specified by name.

public WithRawResponseTask<GetOrganizationByNameResponseContent> GetByNameAsync(string name, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

name string

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetOrganizationByNameResponseContent>

Examples

await client.Organizations.GetByNameAsync("name");

ListAsync(ListOrganizationsRequestParameters, RequestOptions?, CancellationToken)

Retrieve detailed list of all Organizations available in your tenant. For more information, see Auth0 Organizations.

This endpoint supports two types of pagination:

• Offset pagination
• Checkpoint pagination

Checkpoint pagination must be used if you need to retrieve more than 1000 organizations.

Checkpoint Pagination

To search by checkpoint, use the following parameters:

• from: Optional id from which to start selection.
• take: The total number of entries to retrieve when using the from parameter. Defaults to 50.

Note: The first time you call this endpoint using checkpoint pagination, 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 pages are remaining.

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

Parameters

request ListOrganizationsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<Organization>>

Examples

await client.Organizations.ListAsync(
    new ListOrganizationsRequestParameters
    {
        From = "from",
        Take = 1,
        Sort = "sort",
    }
);

UpdateAsync(string, UpdateOrganizationRequestContent, RequestOptions?, CancellationToken)

Update the details of a specific Organization, such as name and display name, branding options, and metadata.

public WithRawResponseTask<UpdateOrganizationResponseContent> UpdateAsync(string id, UpdateOrganizationRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request UpdateOrganizationRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<UpdateOrganizationResponseContent>

Examples

await client.Organizations.UpdateAsync("id", new UpdateOrganizationRequestContent());