Initialize authentication session
Changed onStart a server-side authentication session and discover which sign-in methods are configured for the organization. This is the first step in the multi-step login flow.
Request body (optional)
- You may omit the body, send an empty JSON object {}, or send { "email": "..." }.
- email in the body is optional and kept for legacy reasons; omitting it does not prevent initialization. The web client typically calls this endpoint without a body and sends email on /authenticate instead.
- When provided, email is stored on the session for correlation with subsequent steps.
Flow:
- Call this endpoint (optional JSON body as above).
- Receive a session token in the x-session-token response header.
- Send that token on subsequent /authenticate requests (x-session-token header).
- Use allowedMethods and authProviders from the response to render the login UI.
Session token
- Returned as header x-session-token.
- Required for /authenticate (and related steps) until it expires.
Multi-factor authentication
If the organization has MFA, complete multiple authentication steps; each step may return the next step's allowed methods.
Request
- Base URLhttps://app.pipeshub.com/api/v1
- URLhttps://app.pipeshub.com/api/v1/userAccount/initAuth
- Authnone required
Request body
Example request
{
"email": "user@example.com"
}Response
Authentication session initialized successfully
Example response
{
"allowedMethods": [
"password",
"google",
"otp"
],
"message": "Authentication initialized"
}Changes
- breaking
added the pattern
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9-]*\.)+[A-Za-z]{2,}$to the request property - warning
the
request property's maxLength was set to254 - info
added the media type
application/x-www-form-urlencodedto the request body - info
added the optional property
//to the response with the status
- breaking
- warning
removed the optional property
/from the response with the status - warning
removed the optional property
/from the response with the status - warning
removed the optional property
/from the response with the status - info
removed the
azureAdenum value from the/response property for the response status - info
removed the
oauthenum value from the/response property for the response status - info
removed the
samlSsoenum value from the/response property for the response status
- warning