Skip to main content
POST
Create OAuth connect session

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Body

application/json
integration
string
required

Integration identifier to connect, for example github or slack.

scope
enum<string>
required

Connection ownership within the project.

Available options:
user,
project
redirect_uri
string
required

Validated native or web redirect URI after OAuth completes.

Maximum string length: 4096
project_reference
string

Project UUID or slug that owns the connection.

projectId
string

Deprecated project ID or slug alias. Use project_reference.

project_id
string

Deprecated project ID or slug alias. Use project_reference.

Response

OAuth connect session created

session_token
string
required

One-time OAuth connect session token for native app handoff.

connect_url
string
required

OAuth connect URL that starts the provider consent flow.

expires_at
string<date-time>
required

UTC expiry of this one-time handoff, using the stored session deadline. Open connect_url before this time. Provider consent has a separate lifecycle.