Metadata

MetadataClosed 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 the context of Keyfactor Command, the certificate metadata feature allows you to create custom metadata fields that allow you to tag certificates with tracking information about certificates. in Keyfactor Command allows dynamic information about a certificate, or other data associated with a certificate that isn’t included in the cert itself, to be associated with the certificate within Keyfactor Command. A metadata field can be defined within Keyfactor Command of a given type with a variety of other attributes, such as default values and security constraints. Currently, the supported metadata types are:

  • String
    Alphanumeric text field limited to 400 characters.
  • Integer
    Supports whole numbers only.
  • Date
  • Multiple Choice
  • Big Text
    Big Text fields are limited to 4000 characters. String fields support additional indexing, and so may be preferable to Big Text fields for large databases where possible.
  • Boolean
    True/False

Every certificate in Keyfactor Command can be assigned a value for each metadata field defined. The Metadata Web APIClosed 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. component supports assignment, retrieval, and comparison of metadata values associated with a certificate, as well as retrieval of metadata field definitions. The supported methods are listed in Table 714: Metadata Endpoints.

Table 714: Metadata Endpoints

Endpoint

Method

Description

/2/Compare

POST

Compare the stored value for a metadata field associated with a given certificate against the value given in the request, and return a Boolean indicating whether the values match.

/2/Get

POST

Return the value for a metadata field associated with a given certificate.

/2/Set

POST

Assign a value for a metadata field to a given certificate.

/3/Get

POST

Return the value for a metadata field associated with a given certificate.

/3/GetDefinition

POST

Return the definition for the metadata field with given name.

/3/Set

POST

Assign a value for a metadata field to a given certificate.