Ashley DeBon: Created page with "== Mobile_API »SAML Logout == === Base URL === https://apimobile.callproof.com === Endpoint === /api/saml/logout === Purpose === Logs out the authenticated SAML/mo..."

2026-07-24T07:24:07Z

Created page with "== Mobile_API »SAML Logout == === Base URL === https://apimobile.callproof.com === Endpoint === /api/saml/logout === Purpose === Logs out the authenticated SAML/mo..."

New page

== [[Mobile_API]] »SAML Logout ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/saml/logout

=== Purpose ===
Logs out the authenticated SAML/mobile user: clears the local session/token state, optionally removes the device push token, clears the stored SAML session, and returns an Identity Provider (IdP) logout URL when available so the client can complete single logout with the IdP.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication (`auth:api`).
* Rate limited to 30 requests per minute for the SAML route group.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| fcm_token || string || No || Device push notification token to remove for this user on logout
|}

=== Successful Response (200) ===
Indicates that local logout completed successfully. The client may open <code>idp_logout_url</code> to finish IdP logout when present.

{| class="wikitable"
! Field !! Type !! Description
|-
| message || string || Confirmation message (for example, "Logout Successful")
|-
| idp_logout_url || string/null || IdP single-logout URL when available and valid (http/https); otherwise <code>null</code>
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 400 || Bad Request – SAML logout failed
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token / unauthenticated user
|}

* '''400''' – Logout processing failed (for example, "SLO logout failed").
* '''401''' – Authentication failed or the access token is missing/expired (for example, "Unauthenticated").

SAML Logout - Revision history

Ashley DeBon: Created page with "== Mobile_API »SAML Logout == === Base URL === https://apimobile.callproof.com === Endpoint === /api/saml/logout === Purpose === Logs out the authenticated SAML/mo..."