API Stability Long-Term

The createPersonalUserToken() GraphQL mutation is used to create a personal user token. It will inherit the same permissions as the user. As an alternative, you can use the createPersonalUserTokenV2(), which returns more than the token string.

To change the permissions associated with a personal user token, you can use the updateViewPermissionsTokenPermissions() mutation. Use deleteToken() to delete a token.

Hide Query Example

Show Permissions Query

For more information on access tokens of various types, see the Ingest Tokens documentation page. For information on user authorization, see the Manage Users and Permissions documentation page.

Syntax

graphql
createPersonalUserToken(
      input: CreatePersonalUserTokenInput!
   ): string

There is no special returned datatype for this mutation field.

Example

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

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

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 {
  createPersonalUserToken(input:
      { expireAt: null } )
}"
}
);


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": {
    "createPersonalUserToken": "yaeOlO4GXyIT57ztE3tdqdnq~edXfMu3Yir0FCDVQ95cRoOy0IYL94tqOAaPw1eMK8C9p"
  }
}

Given Datatype

For this input datatype, you may specify the unique identifier of an IP filter that you want to use, and when the token will expire. These are explained in the table below:

Table: CreatePersonalUserTokenInput

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 17, 2024
expireAtlong  Long-TermName of the view of the parser.
ipFilterIdstring  Long-TermName of the parser.