Class OrganizationsClient

Index

Accessors

clientGrants

get clientGrants(): ClientGrantsClient

Returns ClientGrantsClient

clients

get clients(): ClientsClient

Returns ClientsClient

connections

get connections(): ConnectionsClient

Returns ConnectionsClient

discoveryDomains

get discoveryDomains(): DiscoveryDomainsClient

Returns DiscoveryDomainsClient

enabledConnections

get enabledConnections(): EnabledConnectionsClient

Returns EnabledConnectionsClient

invitations

get invitations(): InvitationsClient

Returns InvitationsClient

members

get members(): MembersClient

Returns MembersClient

organizationTemplate

get organizationTemplate(): OrganizationTemplateClient

Returns OrganizationTemplateClient

groups

get groups(): GroupsClient

Returns GroupsClient

roles

get roles(): RolesClient

Returns RolesClient

Constructors

constructor

new OrganizationsClient(options: BaseClientOptions): OrganizationsClient
Parameters
- options: BaseClientOptions
Returns OrganizationsClient

Methods

list

list(
request?: ListOrganizationsRequestParameters,
requestOptions?: OrganizationsClient.RequestOptions,
): Promise<Page<Organization, ListOrganizationsPaginatedResponseContent>>
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.
Parameters
- request: ListOrganizationsRequestParameters = {}
- OptionalrequestOptions: OrganizationsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<Organization, ListOrganizationsPaginatedResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.list({
        include_totals: true,
        from: "from",
        take: 1,
        sort: "sort",
        include_client_association_for: "include_client_association_for"
    })
```

create

create(
request: CreateOrganizationRequestContent,
requestOptions?: OrganizationsClient.RequestOptions,
): HttpResponsePromise<CreateOrganizationResponseContent>
Create a new Organization within your tenant. To learn more about Organization settings, behavior, and configuration options, review Create Your First Organization.
Parameters
- request: CreateOrganizationRequestContent
- OptionalrequestOptions: OrganizationsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<CreateOrganizationResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.ConflictError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.create({
        name: "name"
    })
```

getByName

getByName(
name: string,
requestOptions?: OrganizationsClient.RequestOptions,
): HttpResponsePromise<GetOrganizationByNameResponseContent>
Retrieve details about a single Organization specified by name.
Parameters
- name: string
  name of the organization to retrieve.
- OptionalrequestOptions: OrganizationsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetOrganizationByNameResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.getByName("name")
```

search

search(
    request?: SearchOrganizationsRequestParameters,
    requestOptions?: OrganizationsClient.RequestOptions,
): Promise<
    Page<SearchOrganization, SearchOrganizationsPaginatedResponseContent>,
>
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).
Parameters
- request: SearchOrganizationsRequestParameters = {}
- OptionalrequestOptions: OrganizationsClient.RequestOptions
  Request-specific configuration.
Returns Promise<Page<SearchOrganization, SearchOrganizationsPaginatedResponseContent>>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError

Throws
Management.GatewayTimeoutError
Example
```
await client.organizations.search({
        q: "q",
        parser: "scim",
        take: 1,
        from: "from",
        sort: "name"
    })
```

get

get(
id: string,
requestOptions?: OrganizationsClient.RequestOptions,
): HttpResponsePromise<GetOrganizationResponseContent>
Retrieve details about a single Organization specified by ID.
Parameters
- id: string
  ID of the organization to retrieve.
- OptionalrequestOptions: OrganizationsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<GetOrganizationResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.get("id")
```

delete

delete(
id: string,
requestOptions?: OrganizationsClient.RequestOptions,
): HttpResponsePromise<void>
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.
Parameters
- id: string
  Organization identifier.
- OptionalrequestOptions: OrganizationsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<void>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.NotFoundError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.delete("id")
```

update

update(
    id: string,
    request?: UpdateOrganizationRequestContent,
    requestOptions?: OrganizationsClient.RequestOptions,
): HttpResponsePromise<UpdateOrganizationResponseContent>
Update the details of a specific Organization, such as name and display name, branding options, and metadata.
Parameters
- id: string
  ID of the organization to update.
- request: UpdateOrganizationRequestContent = {}
- OptionalrequestOptions: OrganizationsClient.RequestOptions
  Request-specific configuration.
Returns HttpResponsePromise<UpdateOrganizationResponseContent>
Throws
Management.BadRequestError

Throws
Management.UnauthorizedError

Throws
Management.ForbiddenError

Throws
Management.TooManyRequestsError
Example
```
await client.organizations.update("id")
```

Properties

`Protected` `Readonly`_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

`Protected`_clientGrants

_clientGrants: ClientGrantsClient | undefined

`Protected`_clients

_clients: ClientsClient | undefined

`Protected`_connections

_connections: ConnectionsClient | undefined

`Protected`_discoveryDomains

_discoveryDomains: DiscoveryDomainsClient | undefined

`Protected`_enabledConnections

_enabledConnections: EnabledConnectionsClient | undefined

`Protected`_invitations

_invitations: InvitationsClient | undefined

`Protected`_members

_members: MembersClient | undefined

`Protected`_organizationTemplate

_organizationTemplate: OrganizationTemplateClient | undefined

`Protected`_groups

_groups: GroupsClient | undefined

`Protected`_roles

_roles: RolesClient | undefined

Class OrganizationsClient

Index

Accessors

Constructors

Methods

Properties

Accessors

clientGrants

Returns ClientGrantsClient

clients

Returns ClientsClient

connections

Returns ConnectionsClient

discoveryDomains

Returns DiscoveryDomainsClient

enabledConnections

Returns EnabledConnectionsClient

invitations

Returns InvitationsClient

members

Returns MembersClient

organizationTemplate

Returns OrganizationTemplateClient

groups

Returns GroupsClient

roles

Returns RolesClient

Constructors

constructor

Parameters

Returns OrganizationsClient

Methods

list

Parameters

Returns Promise<Page<Organization, ListOrganizationsPaginatedResponseContent>>

Throws

Throws

Throws

Throws

Example

create

Parameters

Returns HttpResponsePromise<CreateOrganizationResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

getByName

Parameters

Returns HttpResponsePromise<GetOrganizationByNameResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

search

Parameters

Returns Promise<Page<SearchOrganization, SearchOrganizationsPaginatedResponseContent>>

Throws

Throws

Throws

Throws

Throws

Example

get

Parameters

Returns HttpResponsePromise<GetOrganizationResponseContent>

Throws

Throws

Throws

Throws

Throws

Example

delete

Parameters

Returns HttpResponsePromise<void>

Throws

`Protected` `Readonly`_options

`Protected`_clientGrants

`Protected`_clients

`Protected`_connections

`Protected`_discoveryDomains

`Protected`_enabledConnections

`Protected`_invitations

`Protected`_members

`Protected`_organizationTemplate

`Protected`_groups

`Protected`_roles