POST Certificates Import

Required. A string containing the Base64-encoded contents of the certificate to be imported into Keyfactor Command. This may be a certificate with or without associated private key.

The following scenarios are accepted:

• A Base64-encoded certificate without headers, footers, and line feeds.

• A Base64-encoded certificate with headers, footers, and line feeds (in the case that the headers, footers, and line feeds are not Base64-encoded).

• A Base64-encoded certificate with headers, footers, and line feeds that are in the Base64-encoding.

• A Base64 ASCII (PEM) string.

With PowerShell, for example, you could use the following commands to convert certificates of various types to the appropriate format (referencing $b64Cert in the request body Certificate field).

• Certificate in PEM format:

  Copy

  $crtCert = Get-Content 'C:\MyPath\MyCertificate.crt'
  $b64Cert = [System.Convert]::ToBase64String(
     [System.Text.Encoding]::ASCII.GetBytes($crtCert)
  )

  Note:  The commands are the same regardless of whether the PEM certificate file contains a private key. The private key is ignored. If the file contains chain certificates, the end entity certificate must precede the chain certificates. Only the first certificate in the file is imported for this certificate type.

• Certificate in DER format:

  Copy

  $derCert = Get-Content 'C:\MyPath\MyCertificate.der' -Encoding Byte
  $b64Cert = [System.Convert]::ToBase64String($derCert)

• Certificate in PKCS #12 format:

  Copy

  $pfxCert = Get-Content 'C:\MyPath\MyCertificate.pfx' -Encoding Byte
  $b64Cert = [System.Convert]::ToBase64String($pfxCert)

  Note:  Imports of this certificate type require specifying a Password to decrypt the specified file. Both the certificate and private key are imported.

• Certificate in PKCS #7 format:

  Copy

  $p7bCert = Get-Content 'C:\MyPath\MyCertificate.p7b' -Encoding Byte
  $b64Cert = [System.Convert]::ToBase64String($p7bCert)

  Note:  The order of the certificates in the certificate package is not important.

An object containing the 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"
}

An array of objects indicating the information for the specified store IDs. Show store type details.

"Properties": [
   {
      "NetscalerVserver":"MyVirtualServerName"
   }
]

An integer indicating the Keyfactor Command reference ID of the security role to assign as the certificate owner.

A string indicating 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 key, metadata, or location information. Possible values include: