The updateUser() GraphQL mutation is used to update a user in LogScale. It requires root permission.

For more information on user authorization, see the Manage users & permissions documentation page.

Syntax

Below is the syntax for the updateUser() mutation field:

graphql
updateUser(
      input: AddUserInput!
   ): UpdateUserMutation!

Given Datatypes

For the given datatype, AddUserInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: AddUserInput

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 17, 2024
companystring  The name of the company or other entity associated with the user.
countryCodestring  The two-letter ISO 3166-1 Alpha-2 code for the country of residence (e.g., us).
emailstring  The email address for contacting the user related to the account.
firstNamestring  The first name of the user.
fullNamestring  The full name of the user.
isRootboolean  Whether the user has root access.
lastNamestring  The last name or family name of the user.
picturestring  The file name of an image file containing a picture of the user.
stateCodestring  The two-letter, ISO 3166-2 country sub-division code for the state of residence (e.g., ny).
usernamestringyes The name of the user.

Returned Datatypes

The returned datatype UpdateUserMutation has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: UpdateUserMutation

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 4, 2024
UserUseryes The user to update. See User.