Security Requirements and Controls
API Stability Long-Term

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 and Permissions documentation page. To change user information from the LogScale graphical user interface, see Edit a user account.

Syntax

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

graphql
updateUser(
      input: AddUserInput!
   ): UpdateUserMutation!

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  updateUser( input:
       { username: "bob",
         isRoot: true
      } )
  { user { id } }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateUser( input:
       { username: \"bob\",
         isRoot: true
      } )
  { user { id } }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateUser( input:
       { username: \"bob\",
         isRoot: true
      } )
  { user { id } }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateUser( input: ^
       { username: \"bob\", ^
         isRoot: true ^
      } ) ^
  { user { id } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateUser( input:
       { username: \"bob\",
         isRoot: true
      } )
  { user { id } }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  updateUser( input:
       { username: \"bob\",
         isRoot: true
      } )
  { user { id } }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateUser( input:
       { username: \"bob\",
         isRoot: true
      } )
  { user { id } }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateUser( input:
       { username: \"bob\",
         isRoot: true
      } )
  { user { id } }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  path: '/graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updateUser": {
      "user": {
        "id": "Nvu1UOjRtlByBCeKY2K1kgP1"
      }
    }
  }
}

Given Datatypes

For AddUserInput, there are several parameters. Below is a list of them along with a description of each:

Table: AddUserInput

ParameterTypeRequiredDefaultStabilityDescription
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  Long-TermThe name of the company or other entity associated with the user.
countryCodestring  Long-TermThe two-letter ISO 3166-1 Alpha-2 code for the country of residence (e.g., us).
emailstring  Long-TermThe email address for contacting the user related to the account.
firstNamestring  Long-TermThe first name of the user.
fullNamestring  Long-TermThe full name of the user.
isRootboolean  Long-TermWhether the user has root access.
lastNamestring  Long-TermThe last name or family name of the user.
picturestring  Long-TermThe file name of an image file containing a picture of the user.
stateCodestring  Long-TermThe two-letter, ISO 3166-2 country sub-division code for the state of residence (e.g., ny).
usernamestringyes Long-TermThe name of the user.

Returned Datatypes

The returned datatype UpdateUserMutation has one parameter and several sub-parameters. Click on the link below to see a table with the sub-parameters:

Table: UpdateUserMutation

ParameterTypeRequiredDefaultStabilityDescription
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 Long-TermThe user to update. See User.