POST Certificates Revoke All
The POST /Certificates/RevokeAll method is used to revoke all the certificates in the specified query or 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). ID. This endpoint An endpoint is a URL that enables the API to gain access to resources on a server. returns 204 with no content upon success.
Certificate permission can be granted at either the global or collection level. See note under CollectionId, below.
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). (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. and CSR 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 217: POST Certificates Revoke All Input Parameters
| Name | In | Description |
|---|---|---|
| Query | Body | Required*. A string containing a query to limit the certificates to revoke (e.g. field1 -eq value1 AND field2 -gt value2). Fields available for querying through the API 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. for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns. For querying guidelines, refer to the Keyfactor Command Reference Guide Certificate Search Page section. A value for either Query or CollectionId is required. If both Query and CollectionId are specified, certificates from both sources will be revoked. |
| Reason | Body |
An integer containing the specific reason that the certificates are being revoked. The default is Unspecified. |
| Comment | Body | Required. A string containing a freeform reason or comment on why the certificates are being revoked. |
| EffectiveDate | Body | The date and time when the certificate will be revoked. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2021-05-19T16:23:01Z). The default is the current date and time. |
| IncludeRevoked | Body | A Boolean that indicates whether revoked certificates should be included in the revocation (true) or not (false). The default is false. |
| IncludeExpired | Body | A Boolean that indicates whether expired certificates should be included in the revocation (true) or not (false). The default is false. |
| CollectionId | Query | Required*. 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. This field can also be used to specify the certificate collection containing certificates that should be revoked. A value for either Query or CollectionId is required. If both Query and CollectionId are specified, certificates from both sources will be revoked. |
