Certificates Metafield
Certificates Metafield
The metafield POST method is used to import individual certificate 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. field values into Keyfactor Command. This method offers limited functionality and security measures compared to the Metadata v2 and v3 methods described in the Metadata section (see Metadata), but is included for backward-compatibility. A JSON string must be submitted with the POST request containing the data shown in Table 686: POST /1/Metafield Request Body. This method returns HTTP 200 OK with message body "true" on success or an appropriate 4xx status with an accompanying error message in the body on failure.
Table 686: POST /1/Metafield Request Body
Parameter Name |
Parameter Value |
---|---|
CertificateId |
The Keyfactor Command database row identifier associated with the existing certificate. Many times this will be the certificate id returned by the import API call. |
MetadataFieldTypeName |
The string name of the metadata field type for which the value is provided. |
Value |
The metadata field value to be associated with the provided certificate identifier. |
Example Request
POST http://<host>/CMSApi/Certificates/1/Metafield HTTP/1.1
{ "CertificateId": 1, "MetadataFieldTypeName": "Email-Contact", "Value": "support@example.com" }