Security Requirements and Controls
API Stability Long-Term

The removeUserById() GraphQL mutation is used to remove a user by their identifier.

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

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

graphql
removeUserById(
      input: RemoveUserByIdInput!
   ): RemoveUserByIdMutation!

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 Datatypes

RemoveUserByIdInput has one parameter. It's described below:

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 Datatypes

RemoveUserByIdMutation has one parameter, but several sub-parameters. Click on the link in the table below to see them.

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.