Skip to main content

CreateApiKeyInput

Input for the createApiKey mutation. Exactly one of parkPermissions and allParksAuthRoleTemplates must be given.

input CreateApiKeyInput {
  allParksAuthRoleTemplates: [AuthRoleTemplateID!]
  description: String
  name: String!
  parkPermissions: [ApiKeyParkPermissionInput!]
}

Fields​

CreateApiKeyInput.allParksAuthRoleTemplates ● [AuthRoleTemplateID!] list scalar​

Grants the given role templates in every park of the tenant, including parks created later.

CreateApiKeyInput.description ● String scalar​

What this API key is used for.

CreateApiKeyInput.name ● String! non-null scalar​

Name of the API key.

CreateApiKeyInput.parkPermissions ● [ApiKeyParkPermissionInput!] list input​

The permissions this API key gets in individual parks.

Member Of​

createApiKey mutation