Start an SP-initiated SAML single logout
POST /v1/sso/logout: Start an SP-initiated SAML single logout.
POST /v1/sso/logout
Ends the profile’s latest recorded SAML session and returns a broker URL. Redirect the user’s browser there; the broker sends a signed LogoutRequest to the IdP and, when the IdP answers, returns the browser to return_to, which must be a registered redirect URI. Requires single logout on the profile’s connection.
- Scope
sso:exchange- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”
Deterministic: HMAC(connection_id, idp_subject), identical in every cell (doc 02 section 4).profile_idstring Required
A registered redirect URI the browser returns to after the IdP logs out.return_tostring (uri) Requiredmax length 2048
Responses
Section titled “Responses”- 200 OK SsoLogout
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X POST \ "https://api.ohauthcat.com/v1/sso/logout" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "profile_id": "prof_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "return_to": "https://example.com"}'const response = await fetch("https://api.ohauthcat.com/v1/sso/logout", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "profile_id": "prof_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "return_to": "https://example.com" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/sso/logout", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "profile_id": "prof_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "return_to": "https://example.com", },)data = response.json(){ "object": "sso_logout", "logout_url": "https://app.acme.com/callback", "sign_in_id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5"}