Sign in
Organizations

Update an existing organization

post/api/v2/organization/{id}

Request

  • Base URL: https://centralauth.com
  • URL: https://centralauth.com/api/v2/organization/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie accessToken

Path parameters

idstring uuid required

Request body

namestring
logostring uri nullable
customDomainstring nullable
emailConnectionEnabledboolean

Indicates if email connections are enabled for this organization.

passkeyConnectionEnabledboolean

Indicates if passkey connections are enabled for this organization.

centralAuthAppConnectionEnabledboolean

Indicates if CentralAuth app connections are enabled for this organization.

overrideParentSettingsboolean

Response

An organization object with whitelist items, OAuth providers and settings

idstring uuid
tenantIdstring uuid required
namestring required
logostring uri nullable
clientSecretstring

The client secret key for the organization. When creating a new organization, the client secret will be readable once. After that, the client secret will be encrypted and cannot be retrieved.

newClientSecretstring

The new client secret key for the organization to be rotated.

newClientSecretDatestring date-time

The datetime when the new client secret key has been created.

domainstring nullable

The automatically assigned domain for this organization.

customDomainstring nullable
customDomainVerifiedboolean

Indicates if the custom domain has been verified.

emailConnectionEnabledboolean

Indicates if email connections are enabled for this organization.

passkeyConnectionEnabledboolean

Indicates if passkey connections are enabled for this organization.

centralAuthAppConnectionEnabledboolean

Indicates if CentralAuth app connections are enabled for this organization.

overrideParentSettingsboolean
organizationSettingsIdstring uuid
createdstring date-time
updatedstring date-time

Changes

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