createViewPermissionsToken()

API Stability	`Long-Term`

The createViewPermissionsToken() GraphQL mutation field will create a view permission token to use with LogScale. The permissions will take effect across all of the views.

For more information on access tokens of various types, see the Ingest Tokens documentation page. For information on user authorization, see the Manage users & permissions documentation page. You may also want to look at the Creating a Repository or View page for related information.

Syntax

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

graphql

createViewPermissionsToken(
      input: CreateViewPermissionsTokenInput!
   ): string!

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

Show:

graphql

mutation {
  createViewPermissionsToken(input:
        { name: "reader-token",
          expireAt: null,
          viewIds: [ "aK9GKAsTnMXfRxT8Fpecx3fX",
                     "N7t1bAn6xWMsWjVptueeNR16" ],
          permissions: [ ReadAccess ]
        } )
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createViewPermissionsToken(input:
        { name: \"reader-token\",
          expireAt: null,
          viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\",
                     \"N7t1bAn6xWMsWjVptueeNR16\" ],
          permissions: [ ReadAccess ]
        } )
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createViewPermissionsToken(input:
        { name: \"reader-token\",
          expireAt: null,
          viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\",
                     \"N7t1bAn6xWMsWjVptueeNR16\" ],
          permissions: [ ReadAccess ]
        } )
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  createViewPermissionsToken(input: ^
        { name: \"reader-token\", ^
          expireAt: null, ^
          viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\", ^
                     \"N7t1bAn6xWMsWjVptueeNR16\" ], ^
          permissions: [ ReadAccess ] ^
        } ) ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createViewPermissionsToken(input:
        { name: \"reader-token\",
          expireAt: null,
          viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\",
                     \"N7t1bAn6xWMsWjVptueeNR16\" ],
          permissions: [ ReadAccess ]
        } )
}"
}'
    "$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 {
  createViewPermissionsToken(input:
        { name: \"reader-token\",
          expireAt: null,
          viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\",
                     \"N7t1bAn6xWMsWjVptueeNR16\" ],
          permissions: [ ReadAccess ]
        } )
}"
}';
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 {
  createViewPermissionsToken(input:
        { name: \"reader-token\",
          expireAt: null,
          viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\",
                     \"N7t1bAn6xWMsWjVptueeNR16\" ],
          permissions: [ ReadAccess ]
        } )
}"
}'''

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 {
  createViewPermissionsToken(input:
        { name: \"reader-token\",
          expireAt: null,
          viewIds: [ \"aK9GKAsTnMXfRxT8Fpecx3fX\",
                     \"N7t1bAn6xWMsWjVptueeNR16\" ],
          permissions: [ ReadAccess ]
        } )
}"
}
);


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": {
    "createViewPermissionsToken": "ciQrkii7NJtUmtr6N8JQRoLCyuE4nKdT~06PKerqjTkLt6cITyDEvIHnYk82BgOOkof6NrMQMkFOX"
  }
}

Given Datatypes

CreateViewPermissionsTokenInput has a few parameters that may be given. Below is a list of them along with descriptions of each:

Table: CreateViewPermissionsTokenInput

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: Nov 29, 2024
`expireAt`	long		`Long-Term`	When the permission token will expire.
`ipFilterId`	string		`Long-Term`	The unique identifier of the IP filter.
`name`	string	yes	`Long-Term`	The name of the view permission token to create.
`permissions`	[`Permission`]	yes	`Long-Term`	A list of permissions related to the view that are granted. See `Permission`.
`viewIds`	[string]	yes	`Long-Term`	The unique identifiers for the views associated with the permission token.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes