Sign in

Authenticates against the Cognito user pool. Two outcomes:

  • Tokens. The platform row is then checked: the user must exist,
    have a tenant or the PLATFORM_ADMIN role, and be ACTIVE, or
    the call is 401.
  • Challenge. challenge and session are returned and no token
    is issued. An invited user gets NEW_PASSWORD_REQUIRED on their
    first sign-in; a platform admin never gets a challenge.

Every failure on this path is answered with the same 401
Invalid credentials.

Body Params
string
required
length ≥ 1
string
required
length ≥ 1
Headers
string
required
^\d+\.\d+\.\d+$

The version of the Quant Flow API the request follows, as major.minor.patch (for example 1.0.0). The request is interpreted, and the response shaped, according to that version.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json