Skip to main content

ApiKey

A machine-to-machine client. It authenticates without a human user, using the OAuth2 client credentials grant against the tenant realm, and holds the same park-scoped permissions a user holds.

type ApiKey {
  allParksAuthRoleTemplates: [AuthRoleTemplate!]!
  clientId: String!
  createdAt: DateTime!
  createdBy: User
  description: String
  enabled: Boolean!
  id: ApiKeyID!
  lastUsedAt: DateTime
  name: String!
  parkPermissions: [ApiKeyParkPermission!]!
}

Fields​

ApiKey.allParksAuthRoleTemplates ● [AuthRoleTemplate!]! non-null object​

The role templates this API key holds in every park of the tenant, including parks created later. Empty when the key is scoped to individual parks.

ApiKey.clientId ● String! non-null scalar​

The OAuth2 client_id to request a token with. The id without its URN prefix, carrying the apikey- client prefix instead.

ApiKey.createdAt ● DateTime! non-null scalar​

When the API key was created.

ApiKey.createdBy ● User object​

The user that created the API key.

ApiKey.description ● String scalar​

What this API key is used for.

ApiKey.enabled ● Boolean! non-null scalar​

Whether the API key can obtain a token.

ApiKey.id ● ApiKeyID! non-null scalar​

Unique identifier.

ApiKey.lastUsedAt ● DateTime scalar​

When the API key last obtained a token, from the identity provider's event log. Null if it has never been used, or if its events are older than the log keeps.

ApiKey.name ● String! non-null scalar​

Name of the API key, shown to the tenant administrator.

ApiKey.parkPermissions ● [ApiKeyParkPermission!]! non-null object​

The permissions this API key holds in individual parks. Empty when the key holds allParksAuthRoleTemplates instead.

Returned By​

apiKey query ● apiKeys query

Member Of​

CreateApiKeyPayload object ● DeleteApiKeyPayload object ● DisableApiKeyPayload object ● EnableApiKeyPayload object ● RotateApiKeySecretPayload object ● UpdateApiKeyPermissionsPayload object