Sign in

v1

latestOpenAPI 3.0.32026-08-06138294578.6 KB
Organization

Update Organization

Updates an organization's name and SSO or OIDC configuration.

🚧 Requires partner key

This endpoint is only accessible using 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.

put/api/organizations/{id}

Path parameters

idstring uuid required

Unique identifier of the organization to update.

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Unique identifier of the organization to update.

Headers

X-Polytomic-Versionstring

Request body

client_idstring

OIDC client ID issued by the identity provider.

client_secretstring

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

issuerstring

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

namestring required

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

sso_domainstring

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

sso_org_idstring

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

Example request

{
  "client_id": "client_id",
  "client_secret": "client_secret",
  "issuer": "https://example.com",
  "name": "My Organization",
  "sso_domain": "example.com",
  "sso_org_id": "123456"
}

Response

OK

Example response

{
  "data": {
    "issuer": "https://example.com",
    "name": "My Organization",
    "sso_domain": "example.com",
    "sso_org_id": "123456"
  }
}