Objects

ApiKeyRow

Fields

activebooleanrequired
created_atstring (date-time)required
created_byinteger | nullrequired
created_by_namestring | nullrequired
data_profilestring | null
Effective data profile of the key. For the admin role, it is always full.
data_profile_titlestring | null
idintegerrequired
keystring
last_usedstring | nullrequired
namestringrequired
prefixstringrequired
roleRolerequired
expires_atstring (date-time)
Expiration time. Present only for keys with an expiration.
scopesarray of string
Explicit scopes of the key. Present only for keys with explicitly set scopes.
revoked_atstring (date-time)
When the key was revoked. Present only for revoked keys.
collection_idsarray of integer
Collection restriction. Present only for keys with a restriction.
allowed_cidrsarray of string
Allowed networks. Present only for keys with a restriction.
rolled_atstring (date-time)
When the current value was issued by a roll. Present only after a roll.
previous_prefixstring
Beginning of the previous value. Present while the previous value works.
previous_expires_atstring (date-time)
Until when the previous value works. Present while it works.