addUserV2()

The addUserV2() GraphQL mutation may be used to add or invite a new user. Using this with an invitation token will activate the account. By activating the account, the client accepts LogScale's Terms and Conditions.

For more information on user authorization, see the Manage users & permissions documentation page. For information on access tokens of various types, see the Ingest Tokens documentation page.

Syntax

Below is the syntax for the addUserV2() mutation field. Input would be given within the parentheses. The resulting changes will occur within LogScale, but can be returned and captured by specifying the elements desired within the userOrPendingUser type.

graphql

addUserV2(
      input: AddUserInputV2!
   ): userOrPendingUser!

The AddUserInputV2 above would be replaced by parameters with their values, in a comma-separated list, all within a pair of curly brackets. See the examples below for a better understanding.

Raw

graphql

mutation {
  addUserV2 (
    input: {
      username: "steve"
      sendInvite: true
      email: "steve@company.com"
    }
  ) {__typename ... on User {id, 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 {
  addUserV2 (
    input: {
      username: \"steve\"
      sendInvite: true
      email: \"steve@company.com\"
    }
  ) {__typename ... on User {id, 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 {
  addUserV2 (
    input: {
      username: \"steve\"
      sendInvite: true
      email: \"steve@company.com\"
    }
  ) {__typename ... on User {id, 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 { ^
  addUserV2 ( ^
    input: { ^
      username: \"steve\" ^
      sendInvite: true ^
      email: \"steve@company.com\" ^
    } ^
  ) {__typename ... on User {id, username}} ^
}" ^
} '

Windows Powershell and curl

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addUserV2 (
    input: {
      username: \"steve\"
      sendInvite: true
      email: \"steve@company.com\"
    }
  ) {__typename ... on User {id, username}}
}"
}'
"$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" : "mutation {
  addUserV2 (
    input: {
      username: \"steve\"
      sendInvite: true
      email: \"steve@company.com\"
    }
  ) {__typename ... on User {id, 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

python

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  addUserV2 (
    input: {
      username: \"steve\"
      sendInvite: true
      email: \"steve@company.com\"
    }
  ) {__typename ... on User {id, 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 {
  addUserV2 (
    input: {
      username: \"steve\"
      sendInvite: true
      email: \"steve@company.com\"
    }
  ) {__typename ... on User {id, 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

Success (HTTP Response Code 200 OK)

json

{
  "data": {
    "addUserV2": {
      "__typename": "User",
      "id": "mQ2oDkHSLhTG6l6ppsmxJYHJ",
      "username": "steve"
    }
  }
}

This is a simple example of how to add a new user to LogScale — and to have the system send that user an invitation by email. To capture and confirm some of the results, the User return type was added with a couple of parameters. You can see this in the results.

Given Datatypes

For the input (i.e., AddUserInputV2), there are several parameters that may be given. Below is a list of them along with their data type and a description of each:

Table: AddUserInputV2

Parameter	Type	Required	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 17, 2024
`company`	string		The name of the company associated with the user.
`countryCode`	string		The two-letter ISO 3166-1 Alpha-2 code for the country of residence (e.g., us).
`email`	type		The user's email address for communications from LogScale. Required when using sendInvite.
`firstName`	string		The user's actual first name (e.g., Rob). Don't use with fullName.
`fullName`	string		The user's full name (e.g., Rob U. Blindman). Don't use if using other name parameters.
`isOrgOwner`	boolean		Whether the user account is the organization owner.
`isRoot`	boolean		Whether the user account is granted root access.
`lastName`	string		The user's actual last name or family name (e.g., Blindman). Don't use with fullName.
`picture`	type		The file name of an image file for the user.
`sendInvite`	boolean		Whether LogScale should send an email providing the user with information to login.
`stateCode`	string		The two-letter, ISO 3166-2 country sub-division code for the state of residence (e.g., ny).
`username`	string	yes	User name for the login account.
`verificationToken`	string		The verification token for the user account.

As mentioned previously, the addition of a user account and setting of attributes related to that account are made in LogScale, but some values may be captured in return by the application by specifying the desired fields based on the userOrPendingUser schema.

Returned Datatypes

The fields available depend on whether the user has been created, or is instead a pending user. This is determined based on whether the input parameters include not sending an invitation (i.e., sendInvite is set to false). So what's pending is the user acceptance of the invitation.

The schema for the user() possibility includes all of the user account attributes. They are listed in the table below, along with their data type and a description of each. Additionally, the Resultant column is used to indicate whether the respective field is always created and filled with a value.

Table: User

Parameter	Type	Required	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.
`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.
`assetPermissions`	multiple	yes	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`.
`company`	string		The name of the company for the user account.
`countryCode`	string		The two-letter ISO 3166-1 Alpha-2 code for the country of residence (e.g., us).
`createdAt`	datetime	yes	The data and time the account was created.
`displayName`	string	yes	The value of the fullName if used, otherwise the username.
`email`	string		The user account's email address for communications from LogScale.
`firstName`	string		The user's actual first name (e.g., Bob). Don't use with fullName.
`fullName`	string		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`.
`groupsV2`	multiple		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`.
`id`	string	yes	The identifier or token for the user.
`isOrgRoot`	boolean	yes	Whether the organization is granted root access.
`isRoot`	boolean	yes	Whether the user account is granted root access.
`lastName`	string		The user's actual last name or family name (e.g., Smith). Don't use with fullName.
`phoneNumber`	string		The telephone number for LogScale to use for telephone text messages.
`picture`	string		File name of an image file for the account.
`searchAssetPermissions`	multiple		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`.
`searchDomainRoles`	multiple		The search domain roles assigned to the user. The multiple datatype consists of (searchDomainId: string): [SearchDomainRole]. See `SearchDomainRole`.
`searchDomainRolesByName`	multiple	yes	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.
`searchDomainRolesBySearchDomainName`	multiple		The search domain roles assigned to the user by search domain name. The multiple datatype consists of (searchDomainName: string): [SearchDomainRole]. See `SearchDomainRole`.
`stateCode`	string		The two-letter, ISO 3166-2 country sub-division code for the state of residence (e.g., ny).
`permissions`	multiple	yes	Permissions of the user. The multiple datatype consists of (viewName: string): [UserPermissions]. See `UserPermissions`.
`permissionsPage`	multiple	yes	A page of user permissions. The multiple datatype consists of (search: string, pageNumber: integer, pageSize: integer): UserPermissionsPage. See `UserPermissionsPage`.
`rolesV2`	multiple		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`.
`username`	string	yes	The user name for the account.
`userOrGroupSearchDomainRoles`	multiple	yes	The user or group search domain roles. The multiple datatype consists of (search: string, skip: integer, limit: integer): UserOrGroupSearchDomainRoleResultSet. See `UserOrGroupSearchDomainRoleResultSet`.

The schema for the PendingUser possibility includes several fields based on the minimal data collected thus far. They are listed in the table below, along with their data type and a description of each, as well as whether the respective field will always result in it being created and filled with a value.

Table: PendingUser

Parameter	Type	Required	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 27, 2024
`createdAt`	long	yes	The time the pending user was created.
`id`	string	yes	The identifier or token for the pending user.
`idp`	boolean	yes	Whether IdP is enabled for the organization.
`invitedByEmail`	string	yes	The email address of the user that invited the pending user.
`invitedByName`	string	yes	The name of the user that invited the pending user.
`newUserEmail`	string	yes	The email of the pending user.
`orgName`	string	yes	The name of the organization for the pending user.
`pendingUserState`	`pendingUserState`	yes	The current organization state for the user. See `PendingUserState`.

GraphQL Mutation Fields

GraphQL Queries

GraphQL Datatypes

addUserV2()

Syntax

Given Datatypes

Returned Datatypes

Enter search term