Skip to main content
POST
Python

Authorizations

Authorization
string
header
required

Enter your JWT token

Body

application/json

The request describing the application, authentication method, and any provider fields.

Request body for generating an OAuth sign-in URL.

applicationSlug
string
required

Slug of the application to authenticate against.

authenticationId
integer<int32>
required

Identifier of the authentication method to use.

environment
string | null

Optional environment to target for sign-in.

fields
object | null

Optional field values required to build the sign-in URL, keyed by field name.

authProviderId
integer<int32> | null

Optional auth provider to sign in through. 0 uses the connector's own OAuth client; a provider id uses that provider (requires permission to use auth providers). Omit (null) to keep the connection's stored provider when ConnectionId names a connection signed in with the same authentication method; otherwise null uses the application's default provider when that provider's source method is this authentication method (one default per application), or the connector's own client when there is none.

connectionId
integer<int32> | null

Optional existing connection this sign-in re-authenticates. With AuthProviderId omitted, the connection keeps the auth provider it is signed in through instead of moving to the application's default.

Response

The sign-in URL together with the generated state value used to correlate the callback.

Response containing a generated OAuth sign-in URL.

signInUrl
string
required

The URL the user should visit to authenticate.

state
string
required

Opaque state value tying the sign-in flow back to the request.