PUT/v2/organizations/{organizationId}/sso

Set an organization's SSO configuration

Replaces the SSO tenant configuration for an organization. Supply all required configuration fields, and keep each URI, identifier, secret, domain, and token URI within the 255-character limit.

1 parameter · 7 body fields
organizationIdintegerrequired
The numeric identifier of the organization whose SSO configuration to replace.

SSO tenant configuration. Provide all listed fields; string fields can contain up to 255 characters.

authorizationUristringrequired
The authorization endpoint URI. Maximum 255 characters.
clientIdstringrequired
The SSO client identifier. Maximum 255 characters.
clientSecretstringrequired
The SSO client secret. Maximum 255 characters.
domainstringrequired
The domain associated with the SSO configuration. Maximum 255 characters.
enabledbooleanrequired
Whether SSO is enabled for the organization.
forcebooleanrequired
Whether SSO is enforced for the organization.
tokenUristringrequired
The token endpoint URI. Maximum 255 characters.

5 status codes
200Returns the saved SSO configuration, including `authorizationUri`, `clientId`, `clientSecret`, `domain`, `enabled`, `force`, `global`, and `tokenUri`.
authorizationUristringrequired
clientIdstringrequired
clientSecretstringrequired
domainstringrequired
enabledbooleanrequired
forcebooleanrequired
globalbooleanrequired
tokenUristringrequired
400Returned when a required field is missing or the request contains an invalid value, such as a string longer than 255 characters.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is not authenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have permission to change the organization's SSO configuration.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the organization does not exist.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 indicates an invalid request, a 401 indicates missing or invalid authentication, a 403 indicates insufficient permission, and a 404 indicates that the organization was not found. The organizationId path parameter must identify an existing organization. The body must include authorizationUri, clientId, clientSecret, domain, enabled, force, and tokenUri; each string field must be no longer than 255 characters.