PUT Certificates Metadata All

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 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./All method is used to update one or more metadata values for a specified set of active certificates. 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 Overview) are required to use this feature:

Certificates: EditMetadata

Certificate permission can be granted at either the global or 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). level. See note under CollectionId, below.

Table 207: PUT Certificates Metadata All Input Parameters

Name

 In

Description
Query Body

Required*. A string containing a query to limit the certificates to update (e.g. field1 -eq value1 AND field2 -gt value2). Fields available for querying through the 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. for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns. For querying guidelines, refer to the Keyfactor Command Reference Guide Certificate Search Page section. A value for one of CertificateIds, Query, or CollectionId is required.

The query fields supported for this endpoint are:

  • ArchivedKey (True, False)
  • EKU (Extended Key Usage)
  • OU (IssuedOU)
  • SigningAlgorithm
  • CertId
  • EKUName
  • NetBIOSPrincipal (PrincipalName)
  • SSLDNSName
  • CA
  • HasPrivateKey (True, False)
  • PublicKey
  • SSLIPAddress
  • CertState
  • ImportDate
  • NetBIOSRequester (Requester Name)
  • SSLNetworkName
  • CertStoreFQDN
  • IssuedDate (NotBefore)
  • RevocationDate
  • SSLPort
  • CertStorePath
  • IssuerDN
  • Revoker
  • SAN
  • KeySize (KeySizeInBits)
  • RFC2818Compliant (True, False)
  • TemplateDisplayName
  • KeyType
  • SelfSigned (True, False)
  • TemplateShortName
  • ExpirationDate (NotAfter)
  • KeyUsage (CRLSign, DataEncipherment, DicpherOnly, DigitalSignature, EncipherOnly, KeyAgreement, KeyCertSign, KeyEnchipherment,NonRepudiation)
  • SerialNumber
  • Thumbprint
The following fields have been deprecated and will be ignored if included in a request:
  • CARequestID
  • CertRequestId
  • IsPfx
  • RequestResolutionDate
Tip:  To exclude revoked certificates from the update, include a query of:
CertState -ne \"2\"

To exclude expired certificates from the update, include a query of:

ExpirationDate -ge \"%TODAY%\"

CertificateIds

 Body

Required*. An array of Keyfactor Command certificate IDs to update. A value for one of CertificateIds, Query, or CollectionId is required.

Metadata

 Body

Required. An array containing information about the metadata field(s) to update. ClosedShow metadata details.

For example:

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

Required*. 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.

This field can also be used to specify the certificate collection containing certificates that should be updated. A value for one of CertificateIds, Query, or CollectionId is required.