API Stability Long-Term

The createSystemPermissionsToken() GraphQL mutation field is used to create a system permissions token for system-level access. As an alternative, you can use the createSystemPermissionsTokenV2(), which returns more than the token string.

To change the permissions related to a system permissions token, use the updateSystemPermissionsTokenPermissions() mutation. To delete a token, use the deleteToken() mutation.

Hide Query Example

Show System 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
createSystemPermissionsToken(
      input: CreateSystemPermissionTokenInput!
   ): string

Example

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

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

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 {
  createSystemPermissionsToken( input:
     { name: \"admin-nurse\",
       expireAt: null,
       permissions: [ ReadHealthCheck ],
    } )
}"
}
);


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": {
    "createSystemPermissionsToken": "27RT2spHrDgWTKErvYrWOet..."
  }
}

Given Datatype

For this input datatype, you would provide the name of the token, and a list of system permissions. These are listed and explained, along with other parameters, in the table below:

Table: CreateSystemPermissionTokenInput

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-TermThe date when the permission token will expire.
fields[SystemPermission]yes Long-TermA list of system permissions associated with the token. See SystemPermission.
ipFilterIdstring  Long-TermThe unique identifier of the IP filter for the token.
namestringyes Long-TermThe name for the system permission token to create.