UpdateApiKeyInput

Autogenerated input type of UpdateApiKey

input UpdateApiKeyInput {
  clientMutationId: String
  id: ID!
  companyId: ID!
  name: String!
  description: String
  expiresAt: ISO8601DateTime!
  accessProfileId: ID
  teamIds: [ID!]
  accesses: AccessInput
}

Fields

UpdateApiKeyInput.clientMutationId ● String scalar

A unique identifier for the client performing the mutation.

UpdateApiKeyInput.id ● ID! non-null scalar

UpdateApiKeyInput.companyId ● ID! non-null scalar

UpdateApiKeyInput.name ● String! non-null scalar

UpdateApiKeyInput.description ● String scalar

UpdateApiKeyInput.expiresAt ● ISO8601DateTime! non-null scalar

UpdateApiKeyInput.accessProfileId ● ID scalar

The service account's own profile in the company. Leaving it out, or sending null or an empty string, removes it, which is accepted only while a team of the company with a profile covers the account. Its direct accesses are saved either way, but open no asset, project or vulnerability while it has no profile of its own, so a removal also unassigns the account from what only those accesses reached.

UpdateApiKeyInput.teamIds ● [ID!] list scalar

The teams of the company the service account is in, replacing the ones it has. Leaving it out keeps them. A service key's save needs these, the accesses, or both.

UpdateApiKeyInput.accesses ● AccessInput input

The service account's direct accesses, replacing the ones it has. Leaving it out keeps them. A service key's save needs these, the teamIds, or both.

Member Of

updateApiKey mutation