GET Enrollment Available Renewal ID

The GET /EnrollmentClosed 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)./AvailableRenewal/ID/{id} method is used to check a specific certificate by ID to determine which renewal types are supported, if any. This method or the GET /Enrollment/AvailableRenewal/Thumbprint method can be used before using the POST /Enrollment/Renew method to make a determination as to which fields need to be submitted, depending on whether one-click renewal is supported. This method returns HTTP 200 OK on a success with the supported renewal type.

Tip:  The following permissions (see Security Overview) are required to use this feature:

Certificates: Read

At either the global or collectionClosed 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 note under CollectionId, below.

Table 326: GET Enrollment Available Renewal ID {id} Input Parameters

Name In Description
id Path

Required. An integer specifying the Keyfactor Command reference ID of the certificate on which to check the renewal status.

Use the GET /Certificates method to determine the certificate ID. This information is also available in the certificate details for a certificate in the Keyfactor Command Management Portal.
CollectionId Query

An integer specifying an optional certificate collection identifier to validate that the user executing the request has sufficient permissions to do so. If a certificate collection ID is not supplied, the user must have global permissions to complete the action. Supplying a certificate collection ID allows for a check of the user's certificate collection-level permissions to determine whether the user has sufficient permissions at a collection level to complete the action. See Certificate Permissions in the Keyfactor Command Reference Guide for more information.

Table 327: GET Enrollment Available Renewal ID {id} Response Body

Name Description
AvailableRenewalType

An integer indicating the supported renewal type. ClosedShow available renewal types.

Tip:  If the AvailableRenewalType is 2, 1 is also supported for the certificate.
Message A message providing more details about the available renewal type result (e.g. "One click renewal is not available for this certificate. Template does not have PFX enrollment enabled.").
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.