enterprise-identity

Set company-wide SSO policy.

Changed on
put/enterprise-identity/sso-policy

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/enterprise-identity/sso-policy
  • Auth: none declared. Required headers: x-organization-id

Headers

x-organization-idstring required

Active organization id (or slug). Required for org-scoped operations; the generated client enforces it at compile time.

Request body

ssoEnabledboolean required
requireSsoboolean required
expectedVersioninteger required

Response

Response

configuredboolean required
entitledboolean required
provider'okta' | 'entra' | 'google_workspace' | 'auth0' | 'keycloak' | 'zitadel' | 'other' nullable required
issuerstring nullable required
displayNamestring nullable required
jwksUristring nullable required
clientIdstring nullable required
credentialsConfiguredboolean required
companySsoEnabledboolean nullable required
companyRequireSsoboolean nullable required
ssoPolicyVersioninteger required
versioninteger nullable required
createdAtnumber nullable required
updatedAtnumber nullable required
autoJoinOrganizationIdstring nullable required

Changes

    • warning

      added the new auth0 enum value to the / response property for the response status

    • warning

      added the new google_workspace enum value to the / response property for the response status

    • warning

      added the new keycloak enum value to the / response property for the response status

    • warning

      added the new other enum value to the / response property for the response status

    • warning

      added the new zitadel enum value to the / response property for the response status

    • info

      endpoint added