Turn SAML single logout on or off
PUT /v1/connections/{conn}/single_logout: Turn SAML single logout on or off.
PUT /
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
Path parameters
Section titled “Path parameters”connstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Honoured for 24 h; a replay returns the original response.Idempotency-Keystringmin length 1 · max length 255
Request body
Section titled “Request body”enabledboolean Requiredidp_slo_urlstring (uri) or nullmax length 2048
idp_slo_response_urlstring (uri) or nullmax length 2048
idp_slo_bindingstring or nullone of
redirect,post
Responses
Section titled “Responses”- 200 OK SingleLogoutSettings
- 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 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}'const response = await fetch("https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/single_logout", { method: "PUT", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "enabled": true }),});const data = await response.json();import osimport requests
response = requests.put( "https://api.ohauthcat.com/v1/connections/conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/single_logout", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "enabled": True, },)data = response.json(){ "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"}