PUT Certificates Metadata

The PUT /Certificates/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. method is used to update one or more metadata values for a specified certificate. Any existing values for the metadata fields submitted with this update will be overwritten with the new values provided. For more granular control over updating only metadata fields that do not already contain a value, use the PUT /Certificates/Metadata/All method (see PUT Certificates Metadata All). This endpointClosed An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/certificates/collections/metadata/modify/
OR
/certificates/collections/metadata/modify/#/ (where # is a reference to a specific certificate collection ID—see CollectionID, below)
OR
/certificate_stores/metadata/modify/
OR
/certificate_stores/metadata/modify/#/ (where # is a reference to a specific certificate store container ID—see ContainerID, below)

Permissions for certificates can be configured at multiple levels. You can apply them system-wide—for all certificates or all certificate stores—or use fine-grained control by assigning permissions at the certificate collectionClosed The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). or certificate store container level. The appropriate level depends on how the certificates are accessed. See Certificate Collection Permissions and Container Permissions for more information about system-wide versus more targeted permission models.

Table 314: PUT Certificates Metadata Input Parameters

Name

 In

Description
Id Body Required. An integer specifying the Keyfactor Command reference ID for the certificate to update.

Metadata

 Body

Required. An object containing one or more metadata key value pairs to update for the certificate. These are submitted with the metadata field name in the key and the value in the value. For example:

Copy 
"Metadata": {
   "AppOwnerEmailAddress":"john.smith@keyexample.com",  // String field
   "SiteCode":23,                         // Integer field
   "BusinessCritical":true,                 // Boolean field
   "Notes":"Here are some notes about this certificate.", // BigText field
   "BusinessUnit":"E-Business",        // Multiple Choice field with a pre-defined value
   "TicketResolutionDate":"2021-07-23"    // Date field in yyyy-mm-dd format
}
CollectionId Query

An optional integer that specifies the certificate collection (CollectionId) to validate whether the user has sufficient permissions to perform the action. If a CollectionId is not provided, the user must have appropriate permissions granted system-wide or via certificate store containers.

Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order:

  1. System-wide certificate permissions
  2. Granular certificate permissions

Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0).

See Certificate Collection Permissions for more information.
ContainerId Query

An optional integer that specifies the certificate store container (ContainerId) to validate whether the user has sufficient permissions to perform the action. If a ContainerId is not provided, the user must have appropriate permissions granted system-wide or via certificate collections.

Providing a ContainerId allows the system to check the user's permissions at the container level. Permissions are evaluated in the following order:

  1. System-wide certificate permissions
  2. System-wide certificate store container permissions
  3. Granular certificate store container permissions

Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0).

See Container Permissions for more information.
Tip:  See the Keyfactor API Reference and Utility which provides a utility through which 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. endpoints can be called and results returned. It is intended to be used primarily 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. 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 top of the Management Portal page next to the Log Out button.