OAuth Clients

Create a connect-flow key

Mints the API key your servers present alongside X-One-Connect-User-Id to act for a user who connected through this app. The key is bound to this client and confers no access on its own - every request must name a connected user, and what it may do comes from that user's consent. The plaintext is shown once and cannot be recovered; mint another if you lose it.

post/v1/oauth-clients/{client_id}/keys

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/oauth-clients/{client_id}/keys
  • Auth: Session (a scheme the document does not define)

Path parameters

client_idstring required

Public OAuth client ID

Request body

environment'test' | 'live' required
namestring nullable

Shown in the dashboard beside the key. The connect-flow marker is added by the platform, so a name is for telling one deployment from another.

Response

Key created; the plaintext is shown once

accessKeystring required
activeboolean required
changeLogChangeLog required
connectionType'api' | 'databasesql' | 'databasenosql' | 'filesystem' | 'stream' | 'custom' required
createdAtstring date-time required
defaultboolean required
deletedboolean required
environment'test' | 'live' required
idstring required

Prefixed ID with 'evt_ac' prefix (e.g., 'evt_ac_1C'), also accepts raw integer

keystring required
keyPreviewstring nullable
namestring nullable
organizationIdstring uuid nullable
tagsstring[] required
throughputinteger nullable
updatedAtstring date-time required
userIdstring uuid required
versionstring required

Changes

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