Integrations

Confirm a connect session

Changed on

Called by the review page after the human confirms selections.

The body's kind picks the variant (no kind is the OAuth variant): OAuth scopes, a secret for a manual_* session (api_key / bearer / basic), the approver's own OAuth client for an awaiting_app session, or a credential the approver already holds (existing_credential, reauthorize). Secrets are write-only: they never appear in a response, audit entry or log.

Shares the :connect per-actor rate bucket — this is the endpoint that actually fires the vendor's device-authorization call, and a failed begin leaves the session retryable, so it must not be free to hammer during a vendor incident. Gated like the review read (poll_token or owner / org:admin; 403 otherwise).

post/connect-sessions/{session_id}:confirm

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /connect-sessions/{session_id}:confirm
  • Auth: HTTP bearer

Path parameters

session_idstring required

Query parameters

poll_tokenstring nullable

Opaque poll capability returned by :connect. Optional for the target agent's owner (with credentials:write and agents:write) and org:admin

Request body

OR
OR
OR
OR
OR
OR

Response

Successful Response

unknown required

Changes

    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added to the request body oneOf list

    • info

      the query request parameter poll_token became optional

    • info

      query request parameter poll_token list-of-types was widened by adding types null

    • info

      for the query request parameter poll_token, the type was generalized from string to no type