Tolgee Octri Demo
POST/api/public/authorize_oauth/sso/authentication-url

Generate a third-party SSO authentication URL

Generates a redirect URL for authenticating through a third-party SSO service. Supply the SSO domain and a state value for the authentication request. Use the returned redirectUrl to continue the authentication flow.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

SSO authentication URL request containing the domain and state value.

domainstringrequired
The domain associated with the SSO provider.
statestringrequired
The state value to include in the authentication request.

5 status codes
200Returns an object containing `redirectUrl`, the URL to use for third-party SSO authentication.
redirectUrlstringrequired
400Returned when the request is invalid, including when a required body field is missing.
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 authentication is missing or invalid.
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 access to the requested operation is forbidden.
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 a requested resource was not found.
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, and a 401 indicates missing or invalid authentication. A 403 indicates forbidden access, and a 404 indicates that a requested resource was not found. The body must include both domain and state.