SAML Logout
Contents
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
| 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
| 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 idp_logout_url to finish IdP logout when present.
| 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 null
|
Error Responses
| 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").
