GET Certificates Excluded Certificates

The GET /Certificates/ExcludedCertificates operation retrieves all the certificates in the excluded certificates list. On success, the operation returns HTTP 200 OK with  details of the certificates from the exclusion list.

Excluded certificates are removed from active use in Keyfactor Command and are no longer included in standard operations. These certificates are skipped and not re-imported during a CAClosed A certificate authority (CA) is an entity that issues digital certificates. Within Keyfactor Command, a CA may be a Microsoft CA or a Keyfactor gateway to a cloud-based or remote CA. synchronization or manual import (see Delete And Exclude).

Important:  When a certificate is deleted with exclusion, it will not be re-imported during a CA synchronization or add certificate task. However, it will be re-imported if it is found on an SSLClosed TLS (Transport Layer Security) and its predecessor SSL (Secure Sockets Layer) are protocols for establishing authenticated and encrypted links between networked computers. scan or in a certificate store configured for inventory. This ensures that certificates that are still used in the environment are still tracked. A query parser, IsExcluded, is included on the certificate search grid and returns certificates that exist in both the certificate inventory and the exclusion list.
Tip:  The following permissions (see Security Roles and Claims) are required to use this feature:
/certificates/excluded_certificates/read/

Table 292: GET Certificates Excluded Certificates Input Parameters

Name In Description
QueryString Query

A string containing a query to limit the results (for example, field1 -eq value1 AND field2 -gt value2). The default is to return all records. Fields available for querying through the API for the most part match those that appear in the Keyfactor Command Management Portal search dropdowns for the same feature. For querying guidelines, refer to: Searching Excluded Certificates. The query fields supported for this operation are:

  • CertificateThumbprint

  • DateExcluded

  • ExcludingUser

  • IssuedCN
PageReturned Query An integer that specifies how many multiples of the returnLimit to skip and offset by before returning results, to enable paging. The default is 1.
ReturnLimit Query An integer that specifies how many results to return per page. The default is 50. Very large values can result in long processing time.
SortField Query

A string containing the property by which the results should be sorted. Fields available for sorting through the API include: Issued CN, Thumbprint, Date Excluded
SortAscending Query An integer that sets the sort order on the returned results. A value of 0 sorts results in ascending order while a value of 1 sorts results in descending order. The default is ascending.

Table 293: GET Certificates Excluded Certificates Response Data

Name In Description
ID Body

An integer indicating the ID of the excluded certificate. This is a new ID for the certificate since it has been deleted from the Keyfactor Command database and added to the excluded certificates table.
CertificateThumbprint Body A string indicating the thumbprint of the certificate.
IssuedCN Body A string indicating the issued CN of the certificate.
ExcludingUser Body

A string indicating the username of the excluding user.
DateExcluded Body A string indicating the date the certificate was excluded in UTC format.
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.