Security Requirements and Controls
API Stability Long-Term

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

For more information on user authorization, see the Manage Users and Permissions documentation page.

Syntax

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

graphql
updateUserById(
      input: UpdateUserByIdInput!
   ): UpdateUserByIdMutation!

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

Raw
graphql
mutation {
  updateUserById( input:
       { userId: "abc123",
         isRoot: true        
      } )
  { user { username } }
}
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 {
  updateUserById( input:
       { userId: \"abc123\",
         isRoot: true        
      } )
  { user { username } }
}"
}
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 {
  updateUserById( input:
       { userId: \"abc123\",
         isRoot: true        
      } )
  { user { username } }
}"
}
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 { ^
  updateUserById( input: ^
       { userId: \"abc123\", ^
         isRoot: true         ^
      } ) ^
  { user { username } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateUserById( input:
       { userId: \"abc123\",
         isRoot: true        
      } )
  { user { username } }
}"
}'
    "$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 {
  updateUserById( input:
       { userId: \"abc123\",
         isRoot: true        
      } )
  { user { username } }
}";
$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 {
  updateUserById( input:
       { userId: \"abc123\",
         isRoot: true        
      } )
  { user { username } }
}"
}'''

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 {
  updateUserById( input:
       { userId: \"abc123\",
         isRoot: true        
      } )
  { user { username } }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  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": {
    "updateUserById": {
      "user": {
        "username": "bob"
      }
    }
  }
}

Given Datatypes

UpdateUserByIdInput has several parameters that may be given. Below is a list of them along with a description of each:

Table: UpdateUserByIdInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 23, 2024
companystring  Long-TermThe name of the company or organization entity by which the user is affiliated.
countryCodestring  Long-TermThe two-letter ISO 3166-1 Alpha-2 code for the country of residence (e.g., us).
emailstring  Long-TermThe email address of the user for contacting regarding the account.
firstNamestring  Long-TermThe first name of the user.
fullNamestring  Long-TermThe full name of the user.
isRootboolean  Long-TermWhether the user being updated has root access.
lastNamestring  Long-TermThe last name or family name of the user.
picturestring  Long-TermThe name of an image file containing a photograph of the user.
stateCodestring  Long-TermThe two-letter, ISO 3166-2 country sub-division code for the state of residence (e.g., ny).
userIdstringyes Long-TermThe unique identifier of the user to update.
usernamestring  Long-TermThe username for the account to update.

Returned Datatypes

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

Table: UpdateUserByIdMutation

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Apr 2, 2025
userUseryes Long-TermThe user to update based on the unique identifier of the user. See User.