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

For more information on user authorization, see the Managing 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

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

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.


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

ParameterTypeRequired[a]DefaultDescription
userUseryes The user to update (see User Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.