API Stability Long-Term

The updateSystemPermissionsTokenPermissions() GraphQL mutation may be used to update the permissions of a system permission token.

Syntax

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

graphql
updateSystemPermissionsTokenPermissions(
      input: UpdateSystemPermissionsTokenPermissionsInput!
   ): string

There are no special return datatypes for this mutation field. Below is an example of how it might be used:

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

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 {
  updateSystemPermissionsTokenPermissions( input:
    { id: \"abc123\",
      permissions: [ ViewOrganizations ]
    } )
}"
}
);


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": {
    "updateSystemPermissionsTokenPermissions": {
      "id": "abc123"
    }
  }
}

Given Datatypes

For UpdateSystemPermissionsTokenPermissionsInput, there are a couple of parameters that may be given. Below is a list of them along with a description of each:

Table: UpdateSystemPermissionsTokenPermissionsInput

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: Feb 26, 2025
idstringyes Long-TermThe unique identifier for the token.
permissions[SystemPermission]yes Long-TermA list of system permissions. See SystemPermission.