Stream login flow events via SSE

Establishes a Server-Sent Events (SSE) stream that delivers real-time login flow state updates. The stream terminates automatically once the flow reaches a terminal state (SUCCESS, FAILED, EXPIRED, CANCELED).

GET/auth/connections/{id}/events

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

The auth connection ID to follow.

Response

text/event-stream

SSE stream of auth connection state updates.

Union type representing any managed auth event.

An event representing the current state of a managed auth flow.

event*string

Event type identifier (always "managed_auth_state").

timestamp*string

Time the state was reported.

Formatdate-time

flow_status*string

Current flow status.

Value in

"IN_PROGRESS"
"SUCCESS"
"FAILED"
"EXPIRED"
"CANCELED"

flow_step*string

Current step in the flow.

Value in

"DISCOVERING"
"AWAITING_INPUT"
"AWAITING_EXTERNAL_ACTION"
"SUBMITTING"
"COMPLETED"

flow_type?string

Type of the current flow.

Value in

"LOGIN"
"REAUTH"

fields?array<>

Canonical fields awaiting input. Prefer this over discovered_fields when present.

choices?array<>

Canonical choices awaiting selection. Prefer this over pending_sso_buttons, mfa_options, and sign_in_options when present.

discovered_fields?array<>

Fields awaiting input (present when flow_step=AWAITING_INPUT; may also be present with AWAITING_EXTERNAL_ACTION as fallback actions).

mfa_options?array<>

MFA method options (present when flow_step=AWAITING_INPUT; may also be present with AWAITING_EXTERNAL_ACTION as fallback actions).

sign_in_options?array<>

Non-MFA choices presented during the auth flow, such as account selection or org pickers (present when flow_step=AWAITING_INPUT; may also be present with AWAITING_EXTERNAL_ACTION as fallback actions).

pending_sso_buttons?array<>

SSO buttons available (present when flow_step=AWAITING_INPUT; may also be present with AWAITING_EXTERNAL_ACTION as fallback actions).

external_action_message?string

Instructions for external action (present when flow_step=AWAITING_EXTERNAL_ACTION).

website_error?string

Visible error message from the website (e.g., 'Incorrect password'). Present when the website displays an error during login.

error_message?string

Error message (present when flow_status=FAILED).

error_code?string

Machine-readable error code (present when flow_status=FAILED).

post_login_url?string

URL where the browser landed after successful login.

Formaturi

live_view_url?string

Browser live view URL for debugging.

Formaturi

hosted_url?string

URL to redirect user to for hosted login.

Formaturi

curl -X GET "https://example.com/auth/connections/string/events"

{  "event": "managed_auth_state",  "timestamp": "2019-08-24T14:15:22Z",  "flow_status": "IN_PROGRESS",  "flow_step": "DISCOVERING",  "flow_type": "LOGIN",  "fields": [    {      "id": "string",      "ref": "string",      "type": "identifier",      "label": "string",      "required": true,      "observed_selector": "string"    }  ],  "choices": [    {      "id": "string",      "type": "mfa_method",      "label": "string",      "description": "string",      "observed_selector": "string"    }  ],  "discovered_fields": [    {      "name": "string",      "type": "text",      "label": "string",      "placeholder": "string",      "required": true,      "selector": "string",      "linked_mfa_type": "sms",      "hint": "string"    }  ],  "mfa_options": [    {      "type": "sms",      "label": "string",      "target": "string",      "description": "string"    }  ],  "sign_in_options": [    {      "id": "string",      "label": "string",      "description": "string"    }  ],  "pending_sso_buttons": [    {      "selector": "string",      "provider": "string",      "label": "string"    }  ],  "external_action_message": "string",  "website_error": "string",  "error_message": "string",  "error_code": "string",  "post_login_url": "http://example.com",  "live_view_url": "http://example.com",  "hosted_url": "http://example.com"}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}

{  "code": "string",  "message": "string",  "details": [    {      "code": "string",      "message": "string"    }  ],  "inner_error": {    "code": "string",    "message": "string"  }}