API ReferenceOrganization

Create Organization

Creates a new organization under the calling partner account, optionally configuring SSO or OIDC at creation time. > 🚧 Requires partner key > > This endpoint is only accessible using [partner keys](../../guides/obtaining-api-keys#partner-keys). SSO and OIDC settings supplied at creation time can be updated later via `PATCH /api/organizations/{id}`.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
namestringRequired

Human-readable name of the organization. Must be unique across the partner account.

client_idstringOptional
OIDC client ID issued by the identity provider.
client_secretstringOptional

OIDC client secret issued by the identity provider. Write-only; never returned in responses.

issuerstringOptional

OIDC issuer URL for organizations using OpenID Connect single sign-on.

sso_domainstringOptional

Email domain used to match users to this organization during SSO sign-in.

sso_org_idstringOptional

WorkOS organization identifier linking this organization to its SAML/SSO configuration.

Response

OK
dataobject

Errors

401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error