API Stability Long-Term

The updateOrganizationPermissionsTokenPermissions() GraphQL mutation may be used to update the permissions of an organization permission token.

To create an organization permissions token, use the createOrganizationPermissionsTokenV2() mutation. To delete a token, use the deleteToken() mutation.

Hide Query Example

Show Tokens and Permissions Query

For more information on organization settings, see the Organization Settings documentation page. You may also want to look at the Manage Users and Permissions page for related information. For information on access tokens of various types, see the Ingest Tokens documentation page.

Syntax

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

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


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

Given Datatype

For this input datatype, you'll have to provide the unique identifier of the token and a list of organization permissions. The table below has a link to the list of choices:

Table: UpdateOrganizationPermissionsTokenPermissionsInput

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 23, 2024
idstringyes Long-TermThe unique identifier of the organization token.
permissions[OrganizationPermission]yes Long-TermThe list of permissions to grant. See OrganizationPermission.