Skip to main content

CreateApiKeyInput

Autogenerated input type of CreateApiKey

input CreateApiKeyInput {
  activeUntil: ISO8601DateTime
  apiClientId: ID!
  authorizedHosts: [Domain!]
  authorizedIps: [IpAddress!]
  baseUrl: Url
  clientMutationId: String
  name: String!
}

Fields​

CreateApiKeyInput.activeUntil ● ISO8601DateTime scalar common​

The date and time when the API key will expire. If not provided, the API key will never expire.

CreateApiKeyInput.apiClientId ● ID! non-null scalar common​

The ID of the API client for which the API key is being created.

CreateApiKeyInput.authorizedHosts ● [Domain!] list scalar common​

The list of authorized hosts for the API key. This option only applies to API clients that are web applications.

CreateApiKeyInput.authorizedIps ● [IpAddress!] list scalar common​

The list of authorized IP addresses for the API key. This option only applies to API clients that are server-side applications.

CreateApiKeyInput.baseUrl ● Url scalar common​

The base URL for the API client. Emails notifications and other communications will use this URL as base for links.

CreateApiKeyInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

CreateApiKeyInput.name ● String! non-null scalar common​

A descriptive name for the API key.

Member Of​

createApiKey mutation