SAML Link
Revision as of 07:10, 24 July 2026 by Ashley DeBon (talk | contribs) (→Generate SAML SSO Login Link)
Contents
Mobile_API » Generate SAML SSO Login Link
Base URL
https://apimobile.callproof.com
Endpoint
/api/saml/link
Purpose
Starts the SAML single sign-on flow for the mobile app by generating an Identity Provider (IdP) login URL. The client opens this URL so the user can authenticate with SSO. An optional mobile redirect URI and device ID can be supplied for the post-login callback.
HTTP Method
POST
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | No | Not required for this endpoint |
Security
- No – Public endpoint (no Bearer token required).
- Rate limited to 30 requests per minute.
Parameters
Path Parameters
None.
Query Parameters
None.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| redirect_uri | string | No | Mobile deep-link / redirect URI used after SSO (must use an allowed scheme such as callproof or callproofplus). If omitted or invalid, the configured default mobile redirect is used
|
| device_id | string | No | Device identifier stored with the SSO request for later authorization-code exchange |
Successful Response (200)
Returns the IdP login URL to open in the browser / SSO web view.
| Field | Type | Description |
|---|---|---|
| login_url | string | Full SAML login URL for the Identity Provider |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – SSO login URL could not be generated |
| 429 | Too Many Requests – rate limit exceeded |
- 400 – Failed to generate the SSO login URL (for example, "Failed to generate SSO login URL").
- 429 – Too many requests under the SAML throttle limit.
