SAML Single Logout

From docs
Jump to: navigation, search

Mobile_API »SAML Single Logout (SLO)

Base URL

https://apimobile.callproof.com

Endpoint

/api/saml/slo

Purpose

Handles SAML Single Logout (SLO) requests/responses from the Identity Provider. On a valid logout, the matching CallProof user’s access tokens are revoked and the SAML session is cleared. The API may redirect to a return URL when one is provided, or return a JSON confirmation.

HTTP Method

GET, POST

Headers

Header Required Description
Authorization No Not required (public SAML callback under rate limiting)

Security

  • No Bearer token required – This is an IdP callback endpoint.
  • Rate limited to 30 requests per minute.

Parameters

Path Parameters

None.

Query / Body Parameters

(Accepted via query string or form body, depending on SAML binding.)

Parameter Type Required Description
SAMLRequest string Conditional Encoded SAML LogoutRequest from the Identity Provider
SAMLResponse string Conditional Encoded SAML LogoutResponse from the Identity Provider
RelayState string No Optional return/state value from the IdP flow
SigAlg string No Signature algorithm used to sign the SAML message
Signature string No Signature value for the SAML message

Request Body

Same SAML parameters as above when sent via POST (HTTP-POST binding).

Successful Response (200)

Returned when logout completes and there is no valid redirect URL.

Field Type Description
message string Confirmation message (for example, "SLO logout complete")

Redirect success: If the SLO process returns a valid URL, the API responds with an HTTP redirect to that URL instead of JSON.

Error Responses

Status Code Meaning
400 Bad Request – SLO processing failed
  • 400 – SLO could not be completed (for example, "SLO logout failed").