Skip to main content

StaffUpdateInput Input Type

Fields required to update a staff user.

input StaffUpdateInput {
  firstName: String
  lastName: String
  email: String
  isActive: Boolean
  note: String
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
  addGroups: [ID!]
  removeGroups: [ID!]
}

Fields​

firstName ● String​

Given name.

lastName ● String​

Family name.

email ● String​

The unique email address of the user.

isActive ● Boolean​

User account is active.

note ● String​

A note about the user.

metadata ● [MetadataInput!]​

Fields required to update the user metadata. Can be read by any API client authorized to read the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

privateMetadata ● [MetadataInput!]​

Fields required to update the user private metadata. Requires permissions to modify and to read the metadata of the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

addGroups ● [ID!]​

List of permission group IDs to which user should be assigned.

removeGroups ● [ID!]​

List of permission group IDs from which user should be unassigned.

Member Of​

staffUpdate mutation