Start an authorization session

Start an OAuth flow. If the user is already authorized, returns a completed session referencing the existing token. Otherwise returns a pending session with a verification URL the user must visit to finish authorization.

POST /v1/fleet/auth-sessions

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "metadata": {},
  "status": "completed",
  "token": "<string>",
  "url": "<string>",
  "user_id": "<string>"
}

Body

application/json

Authorization session request

provider · string · required

scopes · string[] · required

agent_id · string

force_new · boolean

is_default · boolean

ls_user_id · string

token_id · string

user_id · string

Response

200

application/json

OK

id · string

metadata · object

Show child attributes

status · enum<string>

Available options: completed, pending, connection_required, token_expired, timeout, not_found

token · string

url · string

user_id · string