Skip to main content

ApiKey

A personal API key, as its owner sees it in a list. The token itself is never returned after it is issued

Attributes (8)
AttributeTypeRequiredDescription
idstringYesThe key's identifier, for rotating or revoking it
namestringYesWhat the account called the key
hintstringYesThe token's first characters, enough to recognise the key in a config file and far too few to use
scopesApiKeyScope[]YesWhat the key was granted. A key never does more than the account that owns it
createdAtstringYesWhen the key was issued
expiresAtstringNoWhen the key stops working. Absent means it never expires
lastUsedAtstringNoWhen the key was last used, to within five minutes. Absent means it has not been used
revokedAtstringNoWhen the key was revoked. Present means every request made with it is refused