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

Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/certificates/collections/read/
OR
/certificates/collections/read/#/
OR
/certificate_stores/read/
OR
/certificate_stores/read/#/
AND
/certificates/enrollment/csr/
OR
/certificates/enrollment/pfx/

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 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 available in other places in the Management Portal (for example expiration alerts and certain reports). Permissions and Application 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 482: 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 operation 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 optional integer that specifies the certificate collection (CollectionId) to validate whether the user has sufficient permissions to perform the action. If a CollectionId is not provided, the user must have appropriate permissions granted system-wide or via certificate store applications.

Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order:

  1. System-wide certificate permissions
  2. Granular certificate permissions

Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0).

See Certificate Collection Permissions for more information.
ContainerId Query

An optional integer that specifies the certificate store application (ContainerId) to validate whether the user has sufficient permissions to perform the action. If a ContainerId is not provided, the user must have appropriate permissions granted system-wide or via certificate collections.

Providing a ContainerId allows the system to check the user's permissions at the application level. Permissions are evaluated in the following order:

  1. System-wide certificate store application permissions
  2. Granular certificate store application permissions

Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0).

See Application Permissions for more information.

Table 483: GET Enrollment Available Renewal ID {id} Response Data

Name Description
AvailableRenewalType

An integer indicating the possible renewal types as a sum of supported values.

ClosedShow available renewal types.

Message

A message providing more details about the available renewal type result. For example:

One click renewal is not available for this certificate. Enrollment pattern [Pattern Name] is not available for PFX Enrollment.
Tip:  See the Keyfactor APIClosed 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 workflowClosed 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.