organisations

Update an organisation's profile

Update the caller's own account profile — today the display name. The control plane is the system of record, so the change is authorized here (settings_manage), forwarded on the caller's own bearer, and only once the plane confirms it is this registry's cached copy refreshed from the plane's response. name is replace-only on this route: a value replaces the current one, and it cannot be cleared here. Honors If-Match for optimistic concurrency. The org_id in the path must be the caller's token org: another account's id is a 404, checked before anything else.

patch/registry/v1/organisations/{org_id}

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/{org_id}
  • Auth: HTTP bearer

Path parameters

org_idstring required

Stable identifier of the related org resource.

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 nullable

The account's display name. Trimmed; at most 200 characters, the control plane's own cap.

Response

The updated account record, 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.