organisations

Create an organisation

Create a brand-new organisation with the caller as its owner, independent of the organisation the caller's token belongs to. The control plane decides who may: only a signed-in person whose email domain the deployment allowlists (Atlan staff today), never an agent, a delegated token or a machine credential. The new organisation goes through the same creation transaction as sign-up, so it starts any configured trial. Omit slug to get a unique one derived from name. The caller's current token stays scoped to its current organisation: switch organisations to work in the new one.

post/registry/v1/organisations

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/organisations
  • Auth: HTTP bearer

Headers

Content-Encoding'base64' | 'gzip, base64'

Codings applied to the request body, outermost last. Send base64, or gzip, base64 to compress first; the body is decoded before it is read and Content-Type still names the inner media type. Omit for an unencoded body.

Request body

namestring required

The organisation's display name. Trimmed; 1 to 80 characters.

slugstring nullable

The organisation's handle and the first segment of its dashboard URL: lowercase letters, digits and single hyphens, at most 120 characters, and not a reserved name such as auth or settings. Omit it to derive a unique one from name.

Response

The created organisation, proxied from the control plane.

allow_local_syncboolean required

Whether automatic employee-local skills and traces may sync to this organisation.

allowed_auth_methodsAuthMethod[] required

The sign-in methods the organisation allows.

created_atstring date-time required

When the organisation was created.

created_bystring

The user who created the organisation, when known.

idstring required

The organisation id.

join_policystring required

How people join the organisation: open_auto_join, request_to_join, invite_only, or closed.

namestring required

The organisation's display name.

organisation_type'customer' | 'platform' required

An account's operator-managed classification.

restrict_invites_to_domainsboolean required

Whether invitations must match the organisation's attached email domains.

revoke_credentials_on_offboardboolean required

Whether a member's OAuth clients are disabled when that member is offboarded.

slugstring required

The organisation's URL-safe slug.

status'active' | 'suspended' | 'pending_deletion' | 'archived' required

An organisation's lifecycle status.

updated_atstring date-time required

When the record last changed.

versioninteger required

The record's optimistic-concurrency version.

workos_organization_idstring

The identity-provider organisation linked to this account, when one is.

Changes

No recorded changes to this operation across all 1 revision of this API.