The updateUserById() GraphQL mutation may be used to update a user in LogScale.

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

Syntax

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

graphql
updateUserById(
      input: UpdateUserByIdInput!
   ): UpdateUserByIdMutation!

Given Datatypes

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

Table: UpdateUserByIdInput

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 23, 2024
companystring  The name of the company or organization entity by which the user is affiliated.
countryCodestring  The two-letter ISO 3166-1 Alpha-2 code for the country of residence (e.g., us).
emailstring  The email address of the user for contacting regarding the account.
firstNamestring  The first name of the user.
fullNamestring  The full name of the user.
isRootboolean  Whether the user being updated has root access.
lastNamestring  The last name or family name of the user.
picturestring  The name of an image file containing a photograph of the user.
stateCodestring  The two-letter, ISO 3166-2 country sub-division code for the state of residence (e.g., ny).
userIdstringyes The unique identifier of the user to update.
usernamestring  The username for the account to update.

Returned Datatypes

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

Table: UpdateUserByIdMutation

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.