createViewPermissionsTokenV2()

API Stability	`Long-Term`

The createViewPermissionsTokenV2() GraphQL mutation field is used to create a view permissions token with the specified permissions on the views specified in the viewIds field.

Syntax

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

graphql

createViewPermissionsTokenV2(
       input: CreateViewPermissionsTokenV2Input!
    ): CreateViewPermissionsTokenV2Output!

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

Show:

graphql

mutation {
  createViewPermissionsTokenV2(input:
       { name: "my-view-token", 
         viewIds: [ "aK9GKAsTnMXfRxT8Fpecx3fX", "aK9GKAsTnMXfRxT8Fpecx3fX" ],
         viewPermissions: [ ReadAccess ]
       } )
  { token, tokenMetadata { name, expireAt } }
}

shell

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

shell

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

shell

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

powershell

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

Given Datatypes

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

Table: CreateViewPermissionsTokenV2Input

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 permissions token.
`expireAt`	long		The date the token expires.
`ipFilterId`	string		The unique identifier for the IP filter.
`viewIds`	[string]	yes	The unique identifiers for the views.
`viewPermissions`	[`Permission`]	yes	A list of permissions for the token. See `Permission`.

Returned Datatypes

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

Table: CreateViewPermissionsTokenV2Output

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: Dec 10, 2024
`token`	string	yes	`Long-Term`	The token returned.
`tokenMetadata`	`ViewPermissionsToken`	yes	`Long-Term`	The meta data related to the token. See `ViewPermissionsToken`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes