Skip to content
AugentaDocsOpen console ↗
The API key object

Documentation

API reference
View Markdown

The API key object

Credential metadata, Workspace assignments and recorded activity.

Use a person's credentials to create, list, retrieve and revoke API keys. An API key can make one-shot Consolidate requests; Workspace assignments additionally permit stored-memory access. Key creation requires administration access to every assigned Workspace.

The object below shows retrievable metadata. Creation alone adds the one-time secret field. Save that value in your application's secret configuration; subsequent reads cannot return it. Revocation returns a compact acknowledgment. See API keys for ownership rules.

Available operations

Usage and lifecycle →

The API key object

Attributes

These are response fields. “Always present” can still allow null; “conditional” means the field can be omitted.

objectstringalways present

The resource type. Always api_key.

Allowed: "api_key"

idstringalways present

Public credential identity used in administration routes. It is not the authentication secret.

Min length: 1

orgIdstringalways present

Owning Organization's Augenta ID.

Min length: 1

labelstringalways present

Human-readable credential name.

createdByUserIdstringalways present

Person who issued the credential.

createdAtstringalways present

Recorded credential creation time.

scopestringconditional

Scope metadata, when present.

workspaceIdsarrayconditional

Assigned Workspaces. An empty array permits one-shot Consolidate only.

Show item fields
workspaceIdstringconditional

Legacy single-Workspace assignment, when applicable.

connectorIdstringconditional

Legacy Connector-backed credential reference, when applicable.

lastActiveAtstringconditional

Last recorded authentication activity, when available.

revokedAtstringconditional

Recorded revocation time, when revoked.