Table of Contents

Interface IOrganizationsClient

Namespace
Auth0.ManagementApi
Assembly
Auth0.ManagementApi.dll
public interface IOrganizationsClient
Extension Methods

Properties

ClientGrants 

IClientGrantsClient ClientGrants { get; }

Property Value

IClientGrantsClient

Clients 

IClientsClient Clients { get; }

Property Value

IClientsClient

Connections 

IConnectionsClient Connections { get; }

Property Value

IConnectionsClient

DiscoveryDomains 

IDiscoveryDomainsClient DiscoveryDomains { get; }

Property Value

IDiscoveryDomainsClient

EnabledConnections 

IEnabledConnectionsClient EnabledConnections { get; }

Property Value

IEnabledConnectionsClient

Groups 

IGroupsClient Groups { get; }

Property Value

IGroupsClient

Invitations 

IInvitationsClient Invitations { get; }

Property Value

IInvitationsClient

Members 

IMembersClient Members { get; }

Property Value

IMembersClient

Roles 

IRolesClient Roles { get; }

Property Value

IRolesClient

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.

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

Parameters

request CreateOrganizationRequestContent
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateOrganizationResponseContent>

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.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask

GetAsync(string, RequestOptions?, CancellationToken)

Retrieve details about a single Organization specified by ID.

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

Parameters

id string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetOrganizationResponseContent>

GetByNameAsync(string, RequestOptions?, CancellationToken)

Retrieve details about a single Organization specified by name.

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

Parameters

name string
options RequestOptions
cancellationToken CancellationToken

Returns

WithRawResponseTask<GetOrganizationByNameResponseContent>

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.

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

Parameters

request ListOrganizationsRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task<Pager<Organization>>

SearchAsync(SearchOrganizationsRequestParameters, RequestOptions?, CancellationToken)

Retrieve details of organizations matching a search criteria. It is possible to:

  • Specify a search criteria for organizations
  • Search via name
  • Search via display_name
  • Substring matching (contains and ends-with) requires at least 3 characters
  • Use wildcards

The q query parameter can be used to get organizations that match the specified criteria on name OR display_name.

This endpoint supports SCIM or Lucene filter syntax with low-latency, cursor-based pagination. Use the parser parameter to specify "scim" or "lucene" syntax (default: "lucene").

Results are eventually consistent and may not reflect recent updates immediately.

Sortable fields: name, display_name, created_at (ascending only). Defaults to insertion order (oldest first).

Task<Pager<SearchOrganization>> SearchAsync(SearchOrganizationsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

request SearchOrganizationsRequestParameters
options RequestOptions
cancellationToken CancellationToken

Returns

Task<Pager<SearchOrganization>>

UpdateAsync(string, UpdateOrganizationRequestContent, RequestOptions?, CancellationToken)

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

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>