GET Enrollment Patterns ID Metadata

The GET /EnrollmentPatterns/{id}/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 Keyfactor Command, the certificate metadata feature allows you to create custom metadata fields that allow you to tag certificates with tracking information about certificates. operation retrieves the metadata values for a specified enrollmentClosed Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA). pattern. These settings are determined by combining system-wide metadata defaults with templateClosed A certificate template defines the policies and rules that a CA uses when a request for a certificate is received.-level default values and values configured for the specified enrollment pattern. On success, the operation returns HTTP 200 OK with  details of the derived metadata default values. The response is determined as follows:

  • Enrollment pattern metadata default exists: The enrollment pattern value is returned in the response.

  • Template-level metadata default exists and enrollment pattern value is unset: The template-level default value is returned in the response.

  • Neither template nor enrollment pattern has a default value defined: The corresponding system-wide default value, if defined, is returned in the response.

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

/certificates/enrollment/csr/
OR
/certificates/enrollment/pfx/

Table 521: GET Enrollment Patterns {id} Metadata Input Parameters

Name Description
id

An integer indicating the Keyfactor Command reference ID for the enrollment pattern.

Use the GET Enrollment Patterns operation to retrieve a list of all the enrollment patterns to determine the enrollment pattern ID or view the ID through the Management Portal.

Table 522: GET Enrollment Patterns {id} Metadata Response Data

Name Description
MetadataId An integer indicating the Keyfactor Command reference ID for the metadata field.
DefaultValue

A string containing the derived default value for this metadata setting with which to pre-populate the metadata field for new certificate requests made using PFX or CSR enrollment. This value is based on settings from the enrollment pattern, template, and system-wide metadata configurations.
Validation A string containing the derived regular expression used to validate data entered in a string field. This expression is based on settings from the enrollment pattern, template, and system-wide metadata configurations. If a user enters data that doesn't match the regular expression, the system displays the warning message defined in the Message field.
Enrollment

An integer indicating the derived value for how metadata fields should be handled on the PFX and CSR Enrollment pages. This value is based on settings from the enrollment pattern, template, and system-wide metadata configurations. ClosedShow enrollment details.
Message

A string containing the derived message to present when a user enters information in a metadata field that does not match the specified regular expression (Validation field). This value is based on settings from the enrollment pattern, template, and system-wide metadata configurations.
CaseSensitive A Boolean for string metadata fields with Validation defined, that sets the validation for the field to be case-sensitive (True or False). This value is based on settings from the enrollment pattern, template, and system-wide metadata configurations. If the user's entry for the metadata field does not match the expected case, the Message will display.
Tip:  See the Keyfactor APIClosed 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 workflowClosed 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.