Skip to main content
POST
Create connect session

Authorizations

Authorization
string
header
required

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

Path Parameters

project_reference
string
required

Project ID or slug. A missing or inaccessible project, including a denied scope-dependent project access check, returns not_found.

Minimum string length: 1
name
string
required

Integration name, for example github or slack.

Minimum string length: 1

Body

application/json
scope
enum<string>
required

Connection owner. Project scope needs the editor role; user scope connects your own account and needs viewer access to the project. API keys also need the integrations write scope. Verified user-session or API-key credentials are required; MCP OAuth grants and runtime credentials are refused.

Available options:
user,
project
redirect_uri
string
required

Trusted web or native URI the browser returns to after consent.

Maximum string length: 4096

Response

One-time provider consent link.

session_token
string
required

One-time connect session token, embedded in connect_url.

connect_url
string
required

URL to open in a browser. It starts provider consent through GET /oauth/connect/{integration}.

Example:

"https://api.veryfront.com/oauth/connect/github?session_token=ocs_example"

expires_at
string<date-time>
required

UTC time (RFC 3339) after which connect_url no longer starts consent.