Skip to content
Dashboard
Theme
Theme

Start an SP-initiated SAML single logout

POST /v1/sso/logout: Start an SP-initiated SAML single logout.

View Markdown

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
  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • profile_id string Required

    Deterministic: HMAC(connection_id, idp_subject), identical in every cell (doc 02 section 4).

  • return_to string (uri) Required

    A registered redirect URI the browser returns to after the IdP logs out.

    max length 2048

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"
}'
Response 200
{
"object": "sso_logout",
"logout_url": "https://app.acme.com/callback",
"sign_in_id": "01J9Z3K5V7W8X9Y0Z1A2B3C4D5"
}