Skip to content
Dashboard
Theme
Theme

Turn SAML single logout on or off

PUT /v1/connections/{conn}/single_logout: Turn SAML single logout on or off.

View Markdown

PUT /v1/connections/{conn}/single_logout

When enabled, the connection’s SP metadata advertises SingleLogoutService (HTTP-Redirect and HTTP-POST), the broker accepts signed LogoutRequest messages from the IdP and emits sso.logout, and POST /v1/sso/logout can start an SP-initiated logout. The IdP’s SLO URL comes from its metadata or is set here. Off by default.

Scope
connections:write
Auth
Secret key (sk_…)
Since
1.0
  • conn string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

  • enabled boolean Required

  • idp_slo_url string (uri) or null

    max length 2048

  • idp_slo_response_url string (uri) or null

    max length 2048

  • idp_slo_binding string or null

    one of redirect, post

Errors share one shape; see the error code catalogue.

curl -X PUT \
"https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/single_logout" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enabled": true
}'
Response 200
{
"object": "single_logout",
"connection_id": "conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"enabled": true,
"idp_slo_url": "https://app.acme.com/callback",
"idp_slo_response_url": "https://app.acme.com/callback",
"sp_slo_urls": [
"https://app.acme.com/callback"
],
"idp_slo_binding": "redirect",
"metadata_slo": {
"url": "https://app.acme.com/callback",
"response_url": "https://app.acme.com/callback",
"binding": "redirect"
},
"effective_idp_slo_url": "https://app.acme.com/callback"
}