The POST /Certificates/Analyze operation parses a raw binary certificate returned from a CA
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. into human-readable list of certificate details. For input data supplied with chain certificates, the output will include analysis of the primary certificate and the chain certificates. On success, the operation returns HTTP 200 OK with a list of the contents of the certificate and the certificates in the chain, if applicable.
Permissions for certificates can be set at the system-wide or resource-specific level. The appropriate level depends on how the certificates are accessed. See Certificate Collection Permissions for more information.
In permission strings, # represents a specific resource identifier. In /certificates/collections/ permission strings it refers to a certificate collection ID (for example, CollectionId) and in /certificate_stores/ permission strings it refers to a certificate store application ID (for example, containerId).
Table 322: POST Certificates Analyze Input Parameters
| Name | In | Description |
|---|---|---|
| Certificate | Body |
Required. A string containing either the PEM-encoded string of the certificate not including the header and footer (for example, -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----) or the Base64-encoded contents of the certificate. Both certificates with and without private keys are supported for analysis. |
| Password | Body | A string containing the password used to encrypt the private key of the certificate, if applicable. |
Table 323: POST Certificates Analyze Response Data
| Name | Description |
|---|---|
| IssuedDN | A string containing the distinguished name of the certificate. |
| IssuerDN | A string containing the distinguished name of the issuer of the certificate. |
| Thumbprint | A string containing the thumbprint of the certificate. |
| NotAfter | A string containing the date/time, in UTC, on which the certificate expires. |
| NotBefore | A string containing the date/time, in UTC, on which the certificate was issued by the certificate authority. |
| Metadata | An object containing the metadata fields populated for the certificate. |
| IsEndEntity | A Boolean indicating whether the certificate is the end entity of the chain (True or False). |
An API is 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. Reference and Utility, which allows you to call API operations and view results. It is primarily intended for validation, testing, and workflow A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development, and also serves as an interactive supplement to this API documentation. You can access it from the help menu (
) in the Management Portal.Was this page helpful? Provide Feedback