GET Certificates Query Parsers

The GET /Certificates/QueryParsers method returns the details of all of the query parsers available in Keyfactor Command for certificate searches, along with any 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 defined in Keyfactor Command. This is a comprehensive and up-to-date reference for the queries on the Certificate Search Page and the Custom Query Count Tilefor the dashboard. The response shows the name of each query parser along with whether it is default or not, what type of field it is (i.e., string, Boolean, integer, etc...), what comparisons are enabled for it (with the logical and display names for each), and any defined values (with the display name and the logical value). This method returns HTTP 200 OK on a success with the details.

The query parsers are grouped by Name, and within that group, all of the Fields, organized by Certificate Fields and Metadata.

The response output will be in the format:

[
{
    "Name": "Certificate Fields",
    "Fields": [
	...			
		{
			"name": "ArchivedKey",
			"default": false,
			"type": "bool",
			"comparisons": [
				{
					"shortName": "-eq",
					"displayName": "is equal to"
				},
				{
					"shortName": "-ne",
					"displayName": "is not equal to"
				},
				{
					"shortName": "-null",
					"displayName": "is null"
				},
				{
					"shortName": "-notnull",
					"displayName": "is not null"
				}
				],
			"values": [
				{
					"displayName": "True",
					"value": true
				},
				{
					"displayName": "False",
					"value": false
			}
			]
		}, ...      		

See Certificate Search Page for full instruction on working with certificate queries, including a full list of query parsers, comparison operators and comparison values, along with advanced queries.

Tip:  See the Keyfactor API Reference and Utility which provides a utility through which 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. endpoints can be called and results returned. It is intended to be used primarily 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. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the bottom of the Management Portal side menu.