Skip to main content
POST
Authenticate an already-registered server

Authorizations

Authorization
string
header
required

A Barndoor API key, sent as Authorization: Bearer <key>. Keys are prefixed bdai_ and are opaque — do not attempt to decode one. Interchangeable with an OAuth 2.0 access token.

Path Parameters

server_id
string
required

Query Parameters

return_url
string | null

Optional return URL for redirecting the user after connection completes.

scopes
string | null

Optional space-delimited runtime scope override for the OAuth auth URL. Precedence is: query scopes > server resolved scopes > directory fallback.

as_service
boolean
default:false

Body

application/json

Payload for providing credentials during connection setup.

api_key
string | null
token
string | null
bearer_token
string | null
username
string | null
password
string | null
additional_fields
Additional Fields · object | null

Response

Successful Response

Response model after initiating a connection.

connection_id
string
required
state
string
required
message
string
required
auth_url
string | null