updateUserById()

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 & 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:

Show:

graphql

mutation {
  updateUserById( input:
       { userId: "Nvu1UOjRtlByBCeKY2K1kgP1",
         isRoot: true        
      } )
  { user { username } }
}

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: \"Nvu1UOjRtlByBCeKY2K1kgP1\",
         isRoot: true        
      } )
  { user { username } }
}"
}
EOF

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: \"Nvu1UOjRtlByBCeKY2K1kgP1\",
         isRoot: true        
      } )
  { user { username } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateUserById( input: ^
       { userId: \"Nvu1UOjRtlByBCeKY2K1kgP1\", ^
         isRoot: true         ^
      } ) ^
  { user { username } } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateUserById( input:
       { userId: \"Nvu1UOjRtlByBCeKY2K1kgP1\",
         isRoot: true        
      } )
  { user { username } }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  updateUserById( input:
       { userId: \"Nvu1UOjRtlByBCeKY2K1kgP1\",
         isRoot: true        
      } )
  { user { username } }
}"
}';
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

#! /usr/local/bin/python3

import requests

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

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

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateUserById( input:
       { userId: \"Nvu1UOjRtlByBCeKY2K1kgP1\",
         isRoot: true        
      } )
  { user { username } }
}"
}
);


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

Show:

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

Parameter	Type	Required	Stability	Description
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
`company`	string		`Long-Term`	The name of the company or organization entity by which the user is affiliated.
`countryCode`	string		`Long-Term`	The two-letter ISO 3166-1 Alpha-2 code for the country of residence (e.g., us).
`email`	string		`Long-Term`	The email address of the user for contacting regarding the account.
`firstName`	string		`Long-Term`	The first name of the user.
`fullName`	string		`Long-Term`	The full name of the user.
`isRoot`	boolean		`Long-Term`	Whether the user being updated has root access.
`lastName`	string		`Long-Term`	The last name or family name of the user.
`picture`	string		`Long-Term`	The name of an image file containing a photograph of the user.
`stateCode`	string		`Long-Term`	The two-letter, ISO 3166-2 country sub-division code for the state of residence (e.g., ny).
`userId`	string	yes	`Long-Term`	The unique identifier of the user to update.
`username`	string		`Long-Term`	The 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

Parameter	Type	Required	Stability	Description
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: Apr 2, 2025
`user`	`User`	yes	`Long-Term`	The user to update based on the unique identifier of the user. See `User`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes

updateUserById()

Syntax

Given Datatypes

Returned Datatypes

Enter search term