Skip to content
Developers
Get started
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Finish an IdP-initiated SAML sign-in

POST
/api/v1/auth/sso/saml/idp-complete
curl --request POST \
--url https://api.pitch2sale.com/api/v1/auth/sso/saml/idp-complete \
--header 'Content-Type: application/json' \
--data '{ "code": "example" }'

Used by the web app after the SAML ACS redirects an IdP-initiated (app tile) login to /login?sso=idp#code=…. Redeems the single-use code (valid about two minutes) and sets the refresh cookie. Returns 409 SSO_SESSION_CONFLICT when the browser is already signed in as a different user; the existing session is kept. Only reachable for organizations that allow IdP-initiated login.

Media typeapplication/json
object
code
required
string
>= 20 characters <= 128 characters /^[A-Za-z0-9_-]+$/
Examplegenerated
{
"code": "example"
}

Signed in; exchange the refresh cookie for an access token

Media typeapplication/json
object
success
required
boolean
Example
{
"success": true
}

Unknown, used or expired code (SSO_IDP_EXPIRED)

Already signed in as another user (SSO_SESSION_CONFLICT)

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}