The user() GraphQL query returns information on a user for a given ID.

For more information on user authorization, see the Manage users & permissions documentation page.

Syntax

Below is the syntax for the user() query field:

graphql
user(
     id: string!
   ): User

For the user you would list the parameters of that datatype (see the Returned Datatypes section below). See the example and its results below:

Raw
graphql
query{
  user(id: "TMc2x9a2APnkGvyMJQbxgcOU") {
    username, displayName, email
  }
}
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" : "query{
  user(id: \"TMc2x9a2APnkGvyMJQbxgcOU\") {
    username, displayName, email
  }
}"
}
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" : "query{
  user(id: \"TMc2x9a2APnkGvyMJQbxgcOU\") {
    username, displayName, email
  }
}"
}
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" : "query{ ^
  user(id: \"TMc2x9a2APnkGvyMJQbxgcOU\") { ^
    username, displayName, email ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query{
  user(id: \"TMc2x9a2APnkGvyMJQbxgcOU\") {
    username, displayName, email
  }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query{
  user(id: \"TMc2x9a2APnkGvyMJQbxgcOU\") {
    username, displayName, email
  }
}"
}';
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" : "query{
  user(id: \"TMc2x9a2APnkGvyMJQbxgcOU\") {
    username, displayName, email
  }
}"
}'''

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" : "query{
  user(id: \"TMc2x9a2APnkGvyMJQbxgcOU\") {
    username, displayName, email
  }
}"
}
);


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": {
    "user": {
      "username": "bob",
      "displayName": "Bob Newhart",
      "email": "bob@company.com"
    }
  }
}

You would need to have the lengthy user identifier to provide it for the user input. You might get that by running the users() GraphQL query first. In this example, the username, displayName, and email address are requested. You could request many fields in the same way.

Returned Datatypes

The returned datatype user has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: User

ParameterTypeRequiredDefaultDescription
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
allowedOrganizationActions[OrganizationAction]yes Returns the actions the user is allowed to perform in the organization. See OrganizationAction.
allowedSystemActions[SystemAction]yes Returns the actions the user is allowed to perform in the system. See SystemAction Table.
assetPermissionsmultipleyes 

Get asset permissions assigned to the user for the specific asset. This is a preview and subject to change.

The multiple datatype consists of (assetId: string, assetType: AssetPermissionsAssetType, searchDomainId: string): AssetPermissionsForUser.

See AssetPermissionsAssetType and AssetPermissionsForUser.

companystring  The name of the company for the user account.
countryCodestring  The two-letter ISO 3166-1 Alpha-2 code for the country of residence (e.g., us).
createdAtdatetimeyes The data and time the account was created.
displayNamestringyes The value of the fullName if used, otherwise the username.
emailstring  The user account's email address for communications from LogScale.
firstNamestring  The user's actual first name (e.g., Bob). Don't use with fullName.
fullNamestring  The user's full name (e.g., Bob Smith). Don't use if using other name parameters.
Group[Group]yes The groups of which the user is a member. See Group.
groupSearchDomainRoles[GroupSearchDomainRole]yes The group search domain roles. See GroupSearchDomainRole.
groupsV2multiple  

The groups of which the user is a member. This is a preview and subject to change.

The multiple datatype consists of (search: string, typeFilter: [PermissionType], limit: integer, skip: integer, searchInRoles: boolean): GroupResultSetType.

See PermissionType, and GroupResultSetType.

idstringyes The identifier or token for the user.
isOrgRootbooleanyes Whether the organization is granted root access.
isRootbooleanyes Whether the user account is granted root access.
lastNamestring  The user's actual last name or family name (e.g., Smith). Don't use with fullName.
phoneNumberstring  The telephone number for LogScale to use for telephone text messages.
picturestring  File name of an image file for the account.
searchAssetPermissionsmultiple  

Search for asset permissions for the user. This is a preview and subject to change.

The multiple datatype consists of (searchFilter: string, skip: integer, limit: integer, orderBy: OrderBy, sortBy: SortBy, assetTypes: [AssetPermissionsAssetType], searchDomainIds: [string], permissions: [AssetPermissionInputEnum] = [UpdateAsset], includeUnassignedAssets: boolean): AssetPermissionSearchResultSet.

See AssetPermissionsAssetType, AssetPermissionInputEnum, and AssetPermissionSearchResultSet.

searchDomainRolesmultiple  The search domain roles assigned to the user. The multiple datatype consists of (searchDomainId: string): [SearchDomainRole]. See SearchDomainRole.
searchDomainRolesByNamemultipleyes 

The search domain roles for the user, by name. The multiple datatype consists of (searchDomainName: string): SearchDomainRole. See SearchDomainRole.

This is deprecated because when multiple roles per view is enabled, this field will return only the first of possibly multiple roles matching the name for the view. Therefore, use instead searchDomainRoles or searchDomainRolesBySearchDomainName.

searchDomainRolesBySearchDomainNamemultiple  The search domain roles assigned to the user by search domain name. The multiple datatype consists of (searchDomainName: string): [SearchDomainRole]. See SearchDomainRole.
stateCodestring  The two-letter, ISO 3166-2 country sub-division code for the state of residence (e.g., ny).
permissionsmultipleyes Permissions of the user. The multiple datatype consists of (viewName: string): [UserPermissions]. See UserPermissions.
permissionsPagemultipleyes A page of user permissions. The multiple datatype consists of (search: string, pageNumber: integer, pageSize: integer): UserPermissionsPage. See UserPermissionsPage.
rolesV2multiple  

The roles assigned to the user through a group. This is a preview and subject to change.

The multiple datatype consists of (search: string, typeFilter: [PermissionType], limit: integer, skip: integer, searchInGroups: boolean): RolesResultSetType.

See PermissionType, and RolesResultSetType.

usernamestringyes The user name for the account.
userOrGroupSearchDomainRolesmultipleyes The user or group search domain roles. The multiple datatype consists of (search: string, skip: integer, limit: integer): UserOrGroupSearchDomainRoleResultSet. See UserOrGroupSearchDomainRoleResultSet.