The POST /Enrollment
Certificate enrollment refers to the process by which a user requests a digital certificate. The user must submit the request to a certificate authority (CA)./Renew method is used to enroll for a certificate renewal for a certificate that exists in Keyfactor Command. This method returns HTTP 200 OK on a success with details of the new certificate. For certificates in a certificates store, this method does not automatically deploy the new certificate to the certificate store. In this case, the renew request should be followed by a call to either the POST /Enrollment/PFX 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./Deploy method or POST /Enrollment/PFX/Replace method to deploy the new certificate to the certificate store.
Permissions for certificates can be set at either the global or certificate collection The certificate search function allows you to query the Keyfactor Command database for certificates from any available source based on any criteria of the certificates and save the results as a collection that will be availble in other places in the Management Portal (e.g. expiration alerts and certain reports). level. See Certificate Collection Permissions for more information about global vs collection permissions.
Global or container-level schedule permissions for certificate stores are needed to install a certificate generated with this method into a certificate store using the POST /Enrollment/PFX/Deploy method (see POST Enrollment PFX Deploy) or POST /Enrollment/PFX/Replace method (see POST Enrollment PFX Replace).
A CSR or certificate signing request is a block of encoded text that is submitted to a CA when enrolling for a certificate. When you generate a CSR within Keyfactor Command, the matching private key for it is stored in Keyfactor Command in encrypted format and will be married with the certificate once returned from the CA.), renewal, and revocation requests all flow through Keyfactor Command workflow A workflow is a series of steps necessary to complete a process. In the context of Keyfactor Command, it refers to the workflow builder, which allows you automate event-driven tasks when a certificate is requested or revoked.. This will result in no changes to the enrollment, renewal, and revocation user experience unless customizations have been added in workflow (see Workflow Definitions).Table 409: POST Enrollment Renew Input Parameters
| Name | In | Description |
|---|---|---|
| CertificateId | Body |
Required*. The integer for the certificate in Keyfactor Command that needs to be renewed. Either the CertificateId or the Thumbprint is required but not both. |
| Thumbprint | Body |
Required*. The thumbprint for the certificate that needs to be renewed. Either the CertificateId or the Thumbprint is required but not both. |
| Timestamp | Body |
Required. The current date and time. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z). |
| CertificateAuthority | Body |
Required*. A string that sets the name of the certificate authority that will be used to enroll against. The certificate authority name should be provided in hostname\\logical name format. For example: corpca01.keyexample.com\\CorpIssuingCA1
This field is required if one-click renewal is not supported for the certificate (see GET Enrollment Available Renewal ID or GET Enrollment Available Renewal Thumbprint). |
| Template | Body |
Required*. A string that sets the name of the certificate template that should be used to issue the certificate. The template short name should be used. This field is required if one-click renewal is not supported for the certificate (see GET Enrollment Available Renewal ID or GET Enrollment Available Renewal Thumbprint). |
Table 410: POST Enrollment Renew Response Data
| Name | Description |
|---|---|
| KeyfactorID | ID of the certificate in Keyfactor Command. |
| KeyfactorRequestID | ID of the request in Keyfactor Command. |
| Thumbprint | Thumbprint of the certificate. |
| SerialNumber | Serial number of the certificate. |
| IssuerDN | Issuer DN of the certificate. |
| RequestDisposition | State of the request (e.g. issued). |
| DispositionMessage | Enrollment message (e.g. The private key was successfully retained.). |
| Password | A password generated for convenience for use on installation to a certificate store. This password may be used when deploying the certificate to a certificate store using the POST /Enrollment/Deploy method, though an alternate password may be used. The passwords do not need to match. |
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. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon (
) at the top of the Management Portal page next to the Log Out button.