POST Config Analyzecert

The POST /config/analyzecert method returns public information about a certificate. It is generally used to analyze the certificate used to authenticate the CAClosed A certificate authority (CA) is an entity that issues digital certificates. Within Keyfactor Command, a CA may be a Microsoft CA or a Keyfactor gateway to a cloud-based or remote CA.. This method returns HTTP 200 OK on a success with information about the certificate.

Table 1168: POST Config Analyzecert Input Parameters

Name

In

 Description
StoreName Body A string indicating the certificate store for the certificate (e.g., CA for the intermediate certificate store) when the Source is CertificateStore. This is a reference to the store on the AnyCAGateway REST server.
StoreLocation Body A string indicating the store location for the certificate (e.g., CA LocalMachine) when the Source is CertificateStore. This is a reference to the store on the AnyCAGateway REST server.
Thumbprint Body A string indicating the thumbprint for the certificate when the Source is CertificateStore.
ImportedCertificate Body A string containing the Base64-encoded contents of the certificate file, including any header lines (for example, Subject: and Issuer:) and the full PEM-encoded X.509 certificate (-----BEGIN CERTIFICATE----- / -----END CERTIFICATE-----). This parameter is used when the Source is FileUpload.
ImportedCertificatePassword Body A string containing the password used to decrypt the imported certificate. Required only when ImportedCertificate contains an encrypted or password-protected certificate. This parameter is used when the Source is FileUpload.
FilePath Body

A string containing the path to the certificate file on the AnyCAGateway REST server. The path provided must be relative to the install directory. For example:

./configuration/ca-cert.pem

This parameter is used when the Source is FilePath.
Source Body

A string indicating the source for the certificate. The following values are supported:

  • CertificateStore

  • FilePath

  • FileUpload

Table 1169: POST Config Analyzecert Response Data

Name Description
IssuedDN A string indicating the distinguished name of the certificate.
IssuerDN A string indicating the distinguished name of the issuer.
Thumbprint A string indicating the thumbprint for the certificate.
NotAfter A string containing the date, in UTC, on which the certificate expires.