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
The API key object
Attributes
These are response fields. “Always present” can still allow null; “conditional” means the field can be omitted.
idstringalways presentPublic credential identity used in administration routes. It is not the authentication secret.
Min length: 1
labelstringalways presentHuman-readable credential name.
createdByUserIdstringalways presentPerson who issued the credential.
createdAtstringalways presentRecorded credential creation time.
scopestringconditionalScope metadata, when present.
workspaceIdsarrayconditionalAssigned Workspaces. An empty array permits one-shot Consolidate only.
Show item fields
workspaceIdstringconditionalLegacy single-Workspace assignment, when applicable.
connectorIdstringconditionalLegacy Connector-backed credential reference, when applicable.
lastActiveAtstringconditionalLast recorded authentication activity, when available.
revokedAtstringconditionalRecorded revocation time, when revoked.