Types
ApiKey
object
ApiKeyFields
id
ID!
description
String
permissions
[String!]!
The list of permission strings granted to this API key, e.g. customer:read. These determine which API operations the key is authorized to perform.
impersonationAllowList
The workspace users, roles and custom roles this key may reply as. Empty means nothing has been added yet, so the key cannot reply as anyone.
createdBy
createdAt
updatedBy
updatedAt
isDeleted
Boolean!
Whether the key has been revoked. Deleted keys can no longer authenticate API requests.
deletedAt
The timestamp at which the key was revoked, or null if it is still active.
deletedBy
The actor who revoked the key, or null if it has not been deleted.
Was this page helpful?

