createOrganizationPermissionsTokenV2()

API Stability	`Long-Term`

The createOrganizationPermissionsTokenV2() GraphQL mutation field is used to creates an organization permissions token with the specified permissions.

Syntax

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

graphql

createOrganizationPermissionsTokenV2(
       input: CreateOrganizationPermissionsTokenV2Input!
    ): CreateOrganizationPermissionsTokenV2Output!

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

Show:

graphql

mutation {
  createOrganizationPermissionsTokenV2(input:
         { name: "my-org-access-token",
          organizationPermissions: [ ManageUsers, ViewUsage ]
        })
  { token, tokenMetadata { id, expireAt } }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createOrganizationPermissionsTokenV2(input:
         { name: \"my-org-access-token\",
          organizationPermissions: [ ManageUsers, ViewUsage ]
        })
  { token, tokenMetadata { id, expireAt } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createOrganizationPermissionsTokenV2(input:
         { name: \"my-org-access-token\",
          organizationPermissions: [ ManageUsers, ViewUsage ]
        })
  { token, tokenMetadata { id, expireAt } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  createOrganizationPermissionsTokenV2(input: ^
         { name: \"my-org-access-token\", ^
          organizationPermissions: [ ManageUsers, ViewUsage ] ^
        }) ^
  { token, tokenMetadata { id, expireAt } } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createOrganizationPermissionsTokenV2(input:
         { name: \"my-org-access-token\",
          organizationPermissions: [ ManageUsers, ViewUsage ]
        })
  { token, tokenMetadata { id, expireAt } }
}"
}'
    "$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 {
  createOrganizationPermissionsTokenV2(input:
         { name: \"my-org-access-token\",
          organizationPermissions: [ ManageUsers, ViewUsage ]
        })
  { token, tokenMetadata { id, expireAt } }
}"
}';
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 {
  createOrganizationPermissionsTokenV2(input:
         { name: \"my-org-access-token\",
          organizationPermissions: [ ManageUsers, ViewUsage ]
        })
  { token, tokenMetadata { id, expireAt } }
}"
}'''

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 {
  createOrganizationPermissionsTokenV2(input:
         { name: \"my-org-access-token\",
          organizationPermissions: [ ManageUsers, ViewUsage ]
        })
  { token, tokenMetadata { id, expireAt } }
}"
}
);


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": {
    "createOrganizationPermissionsTokenV2": {
      "token": "aeQOuK6TE5EZfSUEYt6igEzMhzrRJxXF~dElhiSYMbWiVV5Y3rXqMjSvPxD2kzQYlznYWun8QerNU",
      "tokenMetadata": {
        "id": "aeQOuK6TE5EZfSUEYt6igEzMhzrRJxXF",
        "expireAt": null
      }
    }
  }
}

Given Datatypes

For CreateOrganizationPermissionsTokenV2Input, there are a few parameters. Below is a list of them:

Table: CreateOrganizationPermissionsTokenV2Input

Parameter	Type	Required	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: Dec 10, 2024
`name`	string	yes	The name of the organization permissions token.
`expireAt`	long		When the token expires.
`ipFilterId`	string		The unique identifier of the filter to use.
`organizationPermissions`	[`OrganizationPermission`]	yes	A list of organization permissions. See `OrganizationPermission`.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, CreateOrganizationPermissionsTokenV2Output. Below is the parameter of that datatype:

Table: CreateOrganizationPermissionsTokenV2Output

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: Mar 25, 2025
`token`	string	yes	`Long-Term`	The organization permissions token.
`tokenMetadata`	`OrganizationPermissionsToken`	yes	`Long-Term`	Metadata about the token. See `OrganizationPermissionsToken`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes