OAuth

OAUTH Authorize Activate

Stands up an offered-but-prospective connector so the card can connect it.

The card shows a net-new end user the connectors the app offers, not only the ones already stood up for them; a connector on offer with no active connected_platform is prospective, and the completion gate refuses it until a row exists. This leg writes that row on the user's deliberate pick - never on render - and returns the platform the card then runs the ordinary connect against, the same [ConnectedPlatformView] shape the connect listing returns so the widget consumes it identically.

A POST and, unlike the card's reads, a write: it stands up a shared connected_platform and copies One's default credential to the user, so it takes the same first_party_origin: client guard and AuthKit create authority as [authorize_connect], not the reads' laxer stance.

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

post/oauth/authorize/activate

Request

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

Query parameters

state_keystring required

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

connectorstring required

Prefixed ID with 'conn_def' prefix (e.g., 'conn_def_1C'), also accepts raw integer

Response

The freshly stood-up platform, ready for the connect

activatedAtstring date-time nullable
activeboolean required
clientIdDisplaystring nullable
clientSecretDisplaystring nullable
connectionDefIdstring required

Prefixed ID with 'conn_def' prefix (e.g., 'conn_def_1C'), also accepts raw integer

createdAtstring date-time required
environment'test' | 'live' required
guidestring nullable
idstring required

Prefixed ID with 'conn_plf' prefix (e.g., 'conn_plf_1C'), also accepts raw integer

imagestring required
scopesstring nullable
secretIdstring uuid nullable
tagsstring[] required
titlestring required
typestring required
useDefaultOauthCredsboolean required

Changes

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