GET Enrollment Available Renewal ID
The GET /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)./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.
Permissions for certificates can be configured at multiple levels. You can apply them system-wide—for all certificates 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).
Table 462: 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 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 containers. Providing a CollectionId allows the system to check the user's permissions at the certificate collection level. Permissions are evaluated in the following order:
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 container (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 container level. Permissions are evaluated in the following order:
Use either ContainerId or CollectionId, not both. If both are specified, CollectionId takes precedence, and the ContainerId is ignored (defaults to 0). See Container Permissions for more information. |
Table 463: GET Enrollment Available Renewal ID {id} Response Data
Name | Description |
---|---|
AvailableRenewalType |
An integer indicating the possible renewal types as a sum of supported values. |
Message | A message providing more details about the available renewal type result (e.g., One click renewal is not available for this certificate. Enrollment pattern [Pattern Name] is not available for PFX Enrollment.). |



Was this page helpful? Provide Feedback