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 Managing 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

ParameterTypeRequired[a]DefaultDescription
namestringyes The name for the system permission token to create.
expireAtlong  The date when the permission token will expire.
ipFilterIdstring  The unique identifier of the IP filter for the token.
fields[SystemPermission]yes A list of system permissions associated with the token (see SystemPermission Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.