Start an authorization session

Initiates an OAuth flow for the caller. If the user is already authorized, returns a completed session that references an existing token. Otherwise, returns a pending session containing a verification URL the user must visit to complete authorization.

POST /v1/fleet/auth-sessions

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "metadata": {},
  "provider_id": "<string>",
  "token": "<string>",
  "verification_url": "<string>"
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

application/json

agent_id · string

is_default · boolean

provider_id · string

scopes · string[]

strategy · enum<string>

Available options: REUSE, CREATE

token_id · string

Response

200

application/json

Existing token reused; no new session created.

id · string

metadata · object

Show child attributes

provider_id · string

status · enum<string>

Available options: PENDING, COMPLETED, CONNECTION_REQUIRED, TOKEN_EXPIRED

token · string

verification_url · string