Skip to main content

UpdateApiKeyInput

Autogenerated input type of UpdateApiKey

input UpdateApiKeyInput {
  activeUntil: ISO8601DateTime
  authorizedHosts: [Domain!]
  authorizedIps: [IpAddress!]
  baseUrl: Url
  clientMutationId: String
  id: ID!
  name: String
  status: StatusEnum
}

Fields​

UpdateApiKeyInput.activeUntil ● ISO8601DateTime scalar​

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

UpdateApiKeyInput.authorizedHosts ● [Domain!] list scalar​

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

UpdateApiKeyInput.authorizedIps ● [IpAddress!] list scalar​

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

UpdateApiKeyInput.baseUrl ● Url scalar​

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

UpdateApiKeyInput.clientMutationId ● String scalar​

A unique identifier for the client performing the mutation.

UpdateApiKeyInput.id ● ID! non-null scalar​

The ID of the API key to update.

UpdateApiKeyInput.name ● String scalar​

A descriptive name for the API key.

UpdateApiKeyInput.status ● StatusEnum enum​

The status of the API key.

Member Of​

updateApiKey mutation