API Stability Long-Term

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!

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

Show:
graphql
mutation {
  createSystemPermissionsToken( input:
     { name: "admin-nurse",
       expireAt: null,
       permissions: [ ReadHealthCheck ],
    } )
}
Example Responses
Show:
json
{
  "data": {
    "createSystemPermissionsToken": "27RT2spHrDgWTKErvYrWOet..."
  }
}

Given Datatypes

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

Table: CreateSystemPermissionTokenInput

ParameterTypeRequiredDefaultStabilityDescription
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  Long-TermThe date when the permission token will expire.
fields[SystemPermission]yes Long-TermA list of system permissions associated with the token. See SystemPermission.
ipFilterIdstring  Long-TermThe unique identifier of the IP filter for the token.
namestringyes Long-TermThe name for the system permission token to create.