OAuth

OAUTH Authorize Connect

The platforms the card may offer, and the OAuth request the one the user picks will be recorded against.

The other half of [authorize_connections]: that answers "what do you already have", this answers "what can you add". Both narrow to the same offer, so a connector the ceremony never asked for is neither reported as held nor offered as connectable.

A POST because it mints that request; the listing rides along because the card renders both together and a second round trip would let the two disagree about which connectors are on offer.

The tenant headers are declared by hand for the reason [authorize_connections] gives.

post/oauth/authorize/connect

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/oauth/authorize/connect
  • Auth: Session (a scheme the document does not define)

Query parameters

state_keystring required
limitinteger

Items per page. Default 20, hard-capped at 150. limit=0 is treated as 1. Larger values silently clamp.

pageinteger

Page number for pagination (1-indexed). Defaults to 1.

skipinteger

Number of items to skip before the first returned item. Defaults to 0. Most callers should leave this at 0 and rely on page + limit.

Headers

X-One-Organization-Idstring uuid nullable

Selects the organization this request acts in. Omit it to act in your personal scope.

X-One-Project-Idstring uuid nullable

Selects the project this request acts in, inside the organization above.

Request body

groupstring nullable
identitystring nullable
identityType'organization' | 'user' | 'team' | 'project'
labelstring nullable
namestring nullable
tagsstring[] nullable

Response

The platforms on offer, and the request to carry into one

pageinteger required
pagesinteger required
totalinteger required
requestIdstring required

Prefixed ID with 'oauth_req' prefix (e.g., 'oauth_req_1C'), also accepts raw integer

Changes

No recorded changes to this operation across all 1 revision of this API.