GET Certificates Query Parsers

The GET /Certificates/QueryParsers operation returns details of the query parsers available for certificate searches, including any custom certificate metadata Metadata provides information about a piece of data. It is used to summarize basic information about data, which can make working with the data easier. In Keyfactor Command, the certificate metadata feature allows you to create custom metadata fields that allow you to tag certificates with tracking information about certificates. field query parsers for each metadata type you define in Keyfactor Command. This is a comprehensive reference for the queries on Searching Certificates and the Custom Query Count for the dashboard. On success, the operation returns HTTP 200 OK with details of the available query parsers, including supported comparison operators. There are no input parameters for this operation other than the standard headers (see Endpoint Common Features).

Tip: The following permissions (see Security Roles and Claims) are required to use this feature:

/certificates/collections/read/

/certificates/collections/read/#/(where # is a reference to a specific certificate collection.

The response groups query parsers by Name into two categories: Certificate Fields (built-in certificate query parsers) and Metadata (user-defined custom certificate metadata fields).

See Searching Certificates for descriptions of the query parsers for certificates.

Table 303: GET Certificates Query Parsers Response Data

Name

Description

Name

A string indicating the category of query parser.

Fields

An array of objects containing the available query parsers. Show query parser details.

Name

Description

name

A string indicating the Keyfactor Command reference name for the query parser.

default

If relevant, a value indicating the default for the query parser field. The type depends on the field type.

type

A string that specifies the query parser field type. Valid values include the following data types: BigText, bool, datetime, int, ipaddress, multiValued, string, and varbinary.

comparisons

An array of objects indicating the comparison values supported for the query parser. Show comparison operator details.

Name	Description
shortName	A string indicating the comparison operator value (for example, -eq).
displayName	A string indicating a display name for the comparison operator (for example, is equal to).

values

For query parsers containing pre-defined system values, an array of possible values. For example:

[
  {
    "displayName": "True",
    "value": true
  },
  {
    "displayName": "False",
    "value": false
  }
]

Tip: See the Keyfactor API

An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflow

A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development, and also serves as an interactive supplement to this API documentation. You can access it from the help menu (

) in the Management Portal.

Was this page helpful? Provide Feedback

Version v26.2.1

On This Page