The createSystemPermissionsToken() GraphQL mutation field is used to create a system permissions token for system-level access.

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.

Syntax

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

graphql
createSystemPermissionsToken(
      input: CreateSystemPermissionTokenInput!
   ): string!

Given Datatypes

For the given datatype, CreateSystemPermissionTokenInput, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: CreateSystemPermissionTokenInput

ParameterTypeRequiredDefaultDescription
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: Sep 17, 2024
expireAtlong  The date when the permission token will expire.
fields[SystemPermission]yes A list of system permissions associated with the token. See SystemPermission.
ipFilterIdstring  The unique identifier of the IP filter for the token.
namestringyes The name for the system permission token to create.