Skip to main content
GET
Python

Authorizations

Authorization
string
header
required

Enter your JWT token

Path Parameters

state
string
required

The state value returned when the sign-in URL was generated.

Response

The sign-in status.

Token-free status of an OAuth sign-in started with get-sign-in-url. Carries no provider token.

status
string
required

Outcome of the token exchange: pending, signed_in, failed, cancelled or expired (unknown, not yours, or older than the sign-in window).

fieldOptions
object
required

Per-field option lists the connector discovered after sign-in, keyed by connection field name. Empty until the sign-in completes, and for connectors that supply none.

derivedFields
string[]
required

Connection field names the server fills from the sign-in, so a client need not ask for them. Empty until the sign-in completes.

createOutcome
string | null

Outcome of the follow-up connection create, reported separately from Status: connected or failed, or null when no create has run yet. A failed create can be retried with the same sign-in while Status is signed_in.