POST Enrollment Renew
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).


Table 468: POST Enrollment Renew Input Parameters
Name | In | Description |
---|---|---|
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). |
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. |
Enrollment Pattern Id | Body |
Required*. An integer indicating the enrollment pattern to use when renewing the certificate. If this value is not provided, the default enrollment pattern defined for the template provided in the request (see the Template parameter) will be used. One of either the Template or the EnrollmentPatternId is required unless:
If both the Template and EnrollmentPatternId are provided, the settings from the enrollment pattern take precedence. If both are specified, the enrollment will fail if the Template does not match the one defined by the specified enrollment pattern. |
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. See also EnrollmentPatternId. One of either the Template or the EnrollmentPatternId is required unless:
If both the Template and EnrollmentPatternId are provided, the settings from the enrollment pattern take precedence. If both are specified, the enrollment will fail if the Template does not match the one defined by the specified enrollment pattern. Important: The template must be configured with at least one enrollment pattern in order to be used for enrollment (see POST Enrollment Patterns).
Note: This parameter is considered deprecated and may be removed in a future release.
|
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). |
Table 469: POST Enrollment Renew Response Data
Name | Description |
---|---|
DispositionMessage | Enrollment message (e.g. The private key was successfully retained.). |
IssuerDN | Issuer DN of the certificate. |
KeyfactorID | ID of the certificate in Keyfactor Command. |
KeyfactorRequestID | ID of the request in Keyfactor Command. |
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. |
RequestDisposition | State of the request (e.g. issued). |
SerialNumber | Serial number of the certificate. |
Thumbprint | Thumbprint of the certificate. |

