organisations

Update an organisation's settings

Update the caller's own account settings, an allowlist of the fields a member may change (join_policy, auth_method, restrict_invites_to_domains, revoke_credentials_on_offboard). Validated here, then forwarded on the caller's own bearer to the control plane, which is the system of record. Only fields present in the body are forwarded, so an unset field is left untouched. join_policy must be one of open_auto_join, request_to_join, invite_only, closed; auth_method must be one of magic_otp, google, enterprise_sso — both closed vocabularies upstream, so a value outside them is a 400 here rather than a round trip. auth_method is singular: it adds one method, and the account record reports the resulting set as the read-only allowed_auth_methods array; sending that array is a 400. The account profile (name) is not part of this surface — send it to PATCH /organisations/{org_id}; naming it here is a 400 (an unknown field to this route, rejected by deny_unknown_fields). Honors If-Match. 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}/settings

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}/settings
  • 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

auth_methodstring nullable

An authentication method to allow on the account. One of [AUTH_METHODS].

Singular, and it is not the inverse of the read. The account record reports allowed_auth_methods as a read-only array; the plane's write contract takes one auth_method at a time and derives that array itself. Sending the array is a 400 here (an unknown field), which is the honest answer — the plane has no field to put it in.

join_policystring nullable

How people join the account. One of [JOIN_POLICIES].

restrict_invites_to_domainsboolean nullable

Whether invitations are restricted to the account's attached email domains.

revoke_credentials_on_offboardboolean nullable

Whether a member's credentials are revoked when they are offboarded.

Response

The updated account record, proxied from the control plane. The plane has one account-update operation, so the body is the whole record, not a settings-only projection.

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.