POST Certificates Import

The POST /Certificates/Import method is used to import a certificate provided in the request body into Keyfactor Command. This method returns HTTP 200 OK on a success with a message body containing information about the import.

Tip:  The following permissions (see Security Overview) are required to use this feature:

Certificates: Import

Table 208: POST Certificates Import Input Parameters

Name In Description
Certificate Body Required. The base-64 encoded contents of the certificate that is to be imported into Keyfactor Command.
Password Body Required*. The password used to decrypt the imported PFXClosed A PFX file (personal information exchange format), also known as a PKCS#12 archive, is a single, password-protected certificate archive that contains both the public and matching private key and, optionally, the certificate chain. It is a common format for Windows servers.. This field is required if a PFX certificate is provided in the Certificate field.
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. Body

A list of certificate metadata that will be associated with the certificate once it is imported. This is provided as a set of key value pairs with the metadata field name in the key and the value in the value. For example:

"Metadata": {
   "AppOwnerFirstName": "John",
   "AppOwnerLastName": "Smith"
}
StoreIds Body A list of the certificate store GUIDs that the imported certificate will be installed into.
StoreTypes Body The information for the specified store IDs. ClosedShow store type details.
Schedule Body The time the imported certificate should be scheduled to be installed into the certificate store. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2021-05-19T16:23:01Z).

Table 209: POST Certificates Import Response Data

Name Description

ImportStatus

The status of the import job indicating, for example, whether the certificate was newly created in Keyfactor Command or already existed in Keyfactor Command and was just updated based on provided private keyClosed Private keys are used in cryptography (symmetric and asymmetric) to encrypt or sign content. In asymmetric cryptography, they are used together in a key pair with a public key. The private or secret key is retained by the key's creator, making it highly secure., metadata, or location information.
InvaildKeyStores Which key store items failed with some information. ClosedShow key store details.
JobStatus The state of all certificate store jobs.