The assignParserToIngestToken() GraphQL mutation field is used to assign an ingest token to be associated with a parser.

For more information on parsers, see the Parsing Data documentation page. For information on ingest tokens, see Ingest Tokens.

Syntax

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

graphql
assignParserToIngestToken(
      input: AssignParserToIngestTokenInput!
   ): IngestToken!

Given Datatypes

For the input (i.e., AssignParserToIngestTokenInput), there are several parameters that may be given. Below is a list of them along with their data type and a description of each:

Table: AssignParserToIngestTokenInput

ParameterTypeRequired[a]DefaultDescription
groupId[string]yes The unique identifier of the group.
roleIdstring  The unique identifier of the role.

[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.


Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, IngestToken. Below is a list of the parameters of that datatype:

Table: IngestToken

ParameterTypeRequired[a]DefaultDescription
namestringyes Name of ingest token.
tokenstringyes The actual token.
parserParseryes The parser with which the token is associated (see Parser 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.