Event Access

Create Organization Event Access

post/v1/event-access/organizations/{org_id}

Request

  • Base URL: https://api.withone.ai
  • URL: https://api.withone.ai/v1/event-access/organizations/{org_id}
  • Auth: one of:
    • Session (a scheme the document does not define)
    • OAuth 2 (authorization code, authorization URL https://api.withone.ai/oauth/authorize, token URL https://api.withone.ai/oauth/token, scopes: org:secrets:write)

Path parameters

org_idstring uuid required

Organization ID

Headers

X-One-Organization-Idstring uuid

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

Request body

connectionType'api' | 'databasesql' | 'databasenosql' | 'filesystem' | 'stream' | 'custom' required
environment'test' | 'live' required
hideboolean nullable
namestring nullable
tagsstring[]

Free-form labels stored on the key as sent: at most 32, each at most 512 bytes. The CLI records where it is installed here (scope:project, path:…, harness:…). Omitted means no tags.

Response

Created organization event access key

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.