Sign in
auth

Begin an SP-initiated SAML transaction (login, link or reauth).

Changed on

Mints the server-side request, RelayState and initiator binding before returning the IdP HTTP-Redirect URL. login is anonymous; link and reauth require and bind the acting human session. The initiator cookie is delivered only as a Secure, HttpOnly, SameSite=None cookie scoped to this provider's ACS path; it is never returned in JSON.

post/api/v1/auth/saml/{provider}/start

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/auth/saml/{provider}/start
  • Auth: one of:
    • none
    • HTTP bearer

Request body

purposestring required
environment_idstring

Required for reauth; the reveal-window scope.

proofstring

Required for link; the pre-existing account-security proof.

Response

The signed or unsigned IdP HTTP-Redirect URL.

redirect_urlstring uri required

The IdP HTTP-Redirect URL carrying the AuthnRequest.

Changes

  • 54b2780eec85Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f84a1cd8a05aRevision changes
    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status