PUT Certificates Metadata
The PUT /Certificates/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 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. 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 endpoint An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.
Certificate permission can be granted at either the global or collection 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). level. See note under CollectionId, below.
Table 206: 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 array 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: "Metadata": {
"AppOwnerEmailAddress":"john.smith@keyexample.com", // This is a String field.
"SiteCode":23, // This is an Integer field.
"BusinessCritical":true, // This is a Boolean field.
"Notes":"Here are some notes about this certificate.", // This is a BigText field.
"BusinessUnit":"E-Business", // This is a Multiple Choice field with a pre-defined value.
"TicketResolutionDate":"2021-07-23" // This is a Date field in yyyy-mm-dd format.
}
|
| CollectionId | Query |
An integer specifying an optional certificate collection identifier to validate that the user executing the request has sufficient permissions to do so. If a certificate collection ID is not supplied, the user must have global permissions to complete the action. Supplying a certificate collection ID allows for a check of the user's certificate collection-level permissions to determine whether the user has sufficient permissions at a collection level to complete the action. See Certificate Permissions in the Keyfactor Command Reference Guide for more information. |
