Security Requirements and Controls
API Stability Long-Term

The removeUserById() GraphQL mutation is used to remove a user by their identifier. If you know their user name, though, you can use instead the removeUser() mutation.

To add a user, use the addUserV2() mutation. You can update information about a user with the updateUser() or the updateUserById() mutation.

To get a list of pending users — users that have been invited to join the organization but have not yet activated their account — you can use the pendingUsers() query. To get a list of users in general, you can use the users() or the usersPage() queries. You can use user() for information on a specific user.

For more information on user authorization, see the Manage Users and Permissions documentation page. To remove a user account using the LogScale graphical user interface, see Remove a user account.

Syntax

graphql
removeUserById(
      input: RemoveUserByIdInput!
   ): RemoveUserByIdMutation!

Example

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

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

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 {
  removeUserById(input:
     { id: \"T5PE5ql3JdfM8sqoxinUPMrz\" } 
  )
  { user { id, firstName } }
}"
}
);


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": {
    "removeUserById": {
      "user": {
        "id": "T5PE5ql3JdfM8sqoxinUPMrz",
        "firstName": "Bob"
      }
    }
  }
}

Given Datatype

For this input datatype, you'll have to give the unique identifier for the user. The table below describes this:

Table: RemoveUserByIdInput

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 19, 2024
idstringyes Long-TermThe unique identifier of the user to be removed.

Returned Datatype

The return datatype, through sub-parameters, can return a multitude of information on a user account. Besides the usual information (e.g., name, email address, etc.), it can return data about user permissions and access, what groups they're a member and the assets to which they have access. Below is a list of them, along with a description of each, but you'll have to click on the special datatypes for some to see what else you can request:

Table: RemoveUserByIdMutation

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: Oct 3, 2024
userUseryes Long-TermThe user to remove from the mutation. See User.