activateAccount()

API Stability	`Long-Term`

The activateAccount() GraphQL mutation is used to activate a user account, supplying additional personal information. 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.

Syntax

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

graphql

activateAccount(
      firstName: string!,
      lastName: string!,
      email: string!,
      company: string!,
      countryCode: string!,
      stateCode: string,
      zip: string,
      phoneNumber: string,
      utmParams: UtmParams
    ): Account!

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

Show:

graphql

mutation {
  activateAccount(firstName: "Tom", lastName: "Thumb", 
                  company: "Company, Inc.",
                  email: "tom@company.com"
                  countryCode: "us") 
  { id, currentOrganization { id, name } }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  activateAccount(firstName: \"Tom\", lastName: \"Thumb\", 
                  company: \"Company, Inc.\",
                  email: \"tom@company.com\"
                  countryCode: \"us\") 
  { id, currentOrganization { id, name } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  activateAccount(firstName: \"Tom\", lastName: \"Thumb\", 
                  company: \"Company, Inc.\",
                  email: \"tom@company.com\"
                  countryCode: \"us\") 
  { id, currentOrganization { id, name } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  activateAccount(firstName: \"Tom\", lastName: \"Thumb\",  ^
                  company: \"Company, Inc.\", ^
                  email: \"tom@company.com\" ^
                  countryCode: \"us\")  ^
  { id, currentOrganization { id, name } } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  activateAccount(firstName: \"Tom\", lastName: \"Thumb\", 
                  company: \"Company, Inc.\",
                  email: \"tom@company.com\"
                  countryCode: \"us\") 
  { id, currentOrganization { id, name } }
}"
}'
    "$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 {
  activateAccount(firstName: \"Tom\", lastName: \"Thumb\", 
                  company: \"Company, Inc.\",
                  email: \"tom@company.com\"
                  countryCode: \"us\") 
  { id, currentOrganization { id, name } }
}"
}';
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 {
  activateAccount(firstName: \"Tom\", lastName: \"Thumb\", 
                  company: \"Company, Inc.\",
                  email: \"tom@company.com\"
                  countryCode: \"us\") 
  { id, currentOrganization { id, name } }
}"
}'''

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 {
  activateAccount(firstName: \"Tom\", lastName: \"Thumb\", 
                  company: \"Company, Inc.\",
                  email: \"tom@company.com\"
                  countryCode: \"us\") 
  { id, currentOrganization { id, name } }
}"
}
);


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": {
    "activateAccount": {
      "id": "jSl8Iz25KhDiPQzXYE6YDetG",
      "currentOrganization": {
        "id": "SINGLE_ORGANIZATION_ID",
        "name": "SingleOrganization"
      }
    }
  }
}

Given Datatypes

All of the input datatypes are strings except for UtmParams. This datatype has a few parameters. Below is a list of them:

Table: UtmParams

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
`campaign`	string	yes	`Long-Term`	The name of the specific product promotion or strategic marketing campaign related to the UTM (Urchin Tracking Module).
`content`	string	yes	`Long-Term`	What was clicked by the user leading to the server (e.g., a banner ad or text link).
`medium`	string	yes	`Long-Term`	The medium used for the UTM: the type of link used (e.g., cost per click).
`source`	string	yes	`Long-Term`	Which site sent the traffic to the server.
`term`	string	yes	`Long-Term`	The search term related to the UTM.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the input type, Account. This datatype includes several additional parameters for values that may be returned. Below is a list of them:

Table: Account

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: Nov 12, 2024
`announcement`	`Notification`		`Long-Term`	Any announcements for the account. See `Notification`.
`canCreateCloudTrialRepo`	boolean	yes	`Long-Term`	Whether the account may create a cloud trial repository.
`canCreateRepo`	boolean	yes	`Long-Term`	Whether the account can create a repository.
`company`	string		`Long-Term`	The name of the company for the account.
`countryCode`	string		`Long-Term`	The two-letter ISO 3166-1 Alpha-2 code for the country of residence (e.g., us).
`createdAt`	datetime	yes	`Long-Term`	The data and time the account was created.
`currentOrganization`	`Organization`	yes	`Long-Term`	Information on the Organization. See `Organization`.
`email`	string		`Long-Term`	The account's email address for communications from LogScale.
`enabledFeaturesForAccount`	[`FeatureFlag`]	yes	`Long-Term`	Features that are enabled for the account. See `FeatureFlag`.
`externalGroupSynchronization`	boolean	yes	`Long-Term`	Whether there is group synchronization.
`externalPermissions`	boolean	yes	`Long-Term`	Whether permissions are managed externally.
`fieldConfigurations`	multiple	yes	`Long-Term`	The name of the view, as well as fields and how to configure them. The multiple datatype consists of `(viewName: string): [FieldConfiguration]`. See `FieldConfiguration`.
`firstName`	string		`Long-Term`	The user's actual first name (e.g., Bob). Don't use with fullName.
`fullName`	string		`Long-Term`	The user's full name (e.g., Bob Smith). Don't use if using other name parameters.
`id`	string	yes	`Long-Term`	The unique identifier for the account.
`isCloudProAccount`	boolean	yes	`Long-Term`	Whether the account is a cloud professional account.
`isOrganizationRoot`	boolean	yes	`Long-Term`	Whether the organization is granted root access.
`isRoot`	boolean	yes	`Long-Term`	Whether the account is granted root access.
`lastName`	string		`Long-Term`	The user's actual last name or family name (e.g., Smith). Don't use with fullName.
`notificationsV2`	multiple	yes	`Preview`	Notifications for account. The multiple datatype consists of `(typeFilter: [NotificationTypes], orderBy: OrderBy, skip: integer, limit: integer): NotificationsResultSet`. See `NotificationTypes` and `NotificationsResultSet`. This is a preview and subject to change. New sorting and filtering options might be added.
`phoneNumber`	string		`Long-Term`	The telephone number for LogScale to use for telephone text messages.
`picture`	string		`Long-Term`	File name of an image file for the account.
`settings`	`UserSettings`	yes	`Long-Term`	Various default settings for user accounts. See `UserSettings`.
`stateCode`	string		`Long-Term`	The two-letter, ISO 3166-2 country sub-division code for the state of residence (e.g., ny).
`token`	`PersonalUserToken`		`Long-Term`	The personal user token table for the account. See `PersonalUserToken`.
`username`	string	yes	`Long-Term`	The user name for the account.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes