Skip to main content

GqlApiKeyCreateInput

Input for creating a new GraphQL API key

input GqlApiKeyCreateInput {
  name: String!
  active: Boolean! = true
  retrievableOnCreationOnly: Boolean! = false
  roles: [GqlApiKeyRoleInput!]
  channelId: Int = 1
}

Fields​

GqlApiKeyCreateInput.name ● String! non-null scalar​

Name for the API key

GqlApiKeyCreateInput.active ● Boolean! non-null scalar​

Whether the API key is active

GqlApiKeyCreateInput.retrievableOnCreationOnly ● Boolean! non-null scalar​

If true, the key value is returned only in this creation response and can never be retrieved again. Cannot be changed after creation.

GqlApiKeyCreateInput.roles ● [GqlApiKeyRoleInput!] list input​

Roles assigned to this API key

GqlApiKeyCreateInput.channelId ● Int scalar​

Channel ID associated with this API key, if not provided, the default channel will be used

Member Of​

gqlApiKeyCreate mutation