AlmondTill/G3N API

API key

The ApiKey family — 4 operations.

An API key is a machine credential for integrations. Its secret shows exactly once at minting — store it safely; revoke a key to cut an integration off.

Operations

OperationKindWhat it does
apiKeyqueryLook up one record — an API key — a machine credential for integrations.
apiKeysqueryThe api key list — each entry is an API key — a machine credential for integrations.
doomApiKeymutationPermanently retire an API key — a machine credential for integrations.
updateApiKeymutationEdit an API key’s facts (caption); the secret and scopes are immutable.