Skip to main content

GqlApiKey

Represents a GraphQL API key with encrypted key storage

type GqlApiKey {
  id: String!
  name: String!
  key: String!
  active: Boolean!
  roles: [GqlApiKeyRole!]
  channelId: Int
  createdAt: DateTime!
  lastModifiedAt: DateTime!
}

Fields​

GqlApiKey.id ● String! non-null scalar​

Unique identifier for the API key

GqlApiKey.name ● String! non-null scalar​

Name of the API key

GqlApiKey.key ● String! non-null scalar​

The API key value

GqlApiKey.active ● Boolean! non-null scalar​

Whether the API key is active

GqlApiKey.roles ● [GqlApiKeyRole!] list object​

Roles assigned to this API key

GqlApiKey.channelId ● Int scalar​

Channel ID associated with this API key

GqlApiKey.createdAt ● DateTime! non-null scalar​

Timestamp when the API key was created

GqlApiKey.lastModifiedAt ● DateTime! non-null scalar​

Timestamp when the API key was last modified

Returned By​

gqlApiKey query ● gqlApiKeyCreate mutation ● gqlApiKeyUpdate mutation

Member Of​

GqlApiKeyResponse object