UpdateUserInput

UpdateUserInput

Input for updating an existing user. All fields except ‘id’ are optional

Kind: Input

Fields

Field Type Description
email EmailAddress Update the user’s email address (must be valid email format)
externalId String Update the external system identifier
groupIds [String!] Update the list of group IDs the user belongs to
id ID! The unique identifier of the user to update
name String Update the user’s full name
phone PhoneNumber Update the user’s phone number (must be valid phone format)
resetPassword Boolean If true, generates a new temporary password that must be changed on next login
username String Update the username for authentication. If username was not set before, a temporary password will be returned in the response

Definition

"""
Input for updating an existing user. All fields except 'id' are optional
"""
input UpdateUserInput {
  """Update the user's email address (must be valid email format)"""
  email: EmailAddress
  """Update the external system identifier"""
  externalId: String
  """Update the list of group IDs the user belongs to"""
  groupIds: [String!]
  """The unique identifier of the user to update"""
  id: ID!
  """Update the user's full name"""
  name: String
  """Update the user's phone number (must be valid phone format)"""
  phone: PhoneNumber
  """
  If true, generates a new temporary password that must be changed on next login
  """
  resetPassword: Boolean
  """
  Update the username for authentication. If username was not set before, a temporary password will be returned in the response
  """
  username: String
}