API ReferenceOrganization

Update Organization

Updates an organization's name and SSO or OIDC configuration. > 🚧 Requires partner key > > This endpoint is only accessible using [partner keys](../../../guides/obtaining-api-keys#partner-keys). > 📘 SSO and OIDC configuration is replaced in full on each update. Include all > desired settings in the request body, not just the fields you want to change.

Authentication

AuthorizationBearer
Bearer partner API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the organization to update.

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

403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error