The PUT /Reports operation updates the built-in report with the specified report ID. Only some fields can be updated. To create or update a report schedule, use the POST Reports ID Schedules or PUT Reports ID Schedules operation. To update parameters for a built-in report, use the PUT Reports ID Parameters operation. On success, the operation returns HTTP 200 OK with the details of the report.
Table 713: PUT Reports Input Parameters
| Name | In | Description |
|---|---|---|
| Id | Body |
Required. The Keyfactor Command reference ID of the built-in report that should be updated. Use the GET Reports operation to retrieve a list of your built-in reports to determine the report ID to use. |
| InNavigator | Body | A Boolean that indicates whether the report has been configured to display on the Keyfactor Command Management Portal menu (True or False). |
| Favorite | Body | A Boolean that indicates whether the report has been marked as a favorite (True or False). |
| RemoveDuplicates | Body | A Boolean that indicates whether the report uses certificate de-duping logic in producing output (True or False). Tip: When de-duplication is turned on for a report, the report results will include only the most recently issued certificate if there is more than one certificate that matches the de-duplication criteria. De-duplication can only be turned on for reports that use certificate collections—the UsesCollection parameter. The UsesCollection parameter is not user-configurable. Certificate de-duping is configured on a certificate collection using the DuplicationField parameter (see POST Certificate Collections). This corresponds to the Keyfactor Command Management Portal Ignore renewed certificate results by option on a certificate collection. Certificate collections may be configured to be de-duplicated based on the certificate common name, distinguished name, or principal name (or not at all). Only certificates that share all the EKUs (for example, Client Authentication and Server Authentication) as well as the same CN, DN or UPN will be eliminated as duplicates. If a certificate has more than one EKU and at least one EKU does not match an otherwise similar certificate with matching CN, DN or UPN, it will not be eliminated. |
Table 714: PUT Reports Response Data
| Name |
Description |
|---|---|
| Id | An integer containing the Keyfactor Command reference ID for the report. |
| Display Name | A string containing the display name for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page, at the top of the page for the generated report, and on the menu. Tip: Exported reports use built-in names; modifying this value will not change the name that appears at the top of the exported version of a report (for example, a PDF). |
| Description | A string containing the description for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page and at the top of the page for the generated report. |
| Report Path | A string containing the name of the report as referenced when retrieving it via Logi Analytics. |
| Version Number | A string containing the version number for the report. |
| Categories |
A string containing the report category or categories in which the report is found on the report manager page in the Keyfactor Command Management Portal. The possible values are:
|
| Short Name | A string containing the short reference name for the report. |
| In Navigator | A Boolean that indicates whether the report has been configured to display on the Keyfactor Command Management Portal menu (True or False). |
| Favorite | A Boolean that indicates whether the report has been marked as a favorite (True or False). |
| Remove Duplicates | A Boolean that indicates whether the report uses certificate de-duping logic in producing output (True or False).
Tip: When de-duplication is turned on for a report, the report results will include only the most recently issued certificate if there is more than one certificate that matches the de-duplication criteria. De-duplication can only be turned on for reports that use certificate collections—the UsesCollection parameter. The UsesCollection parameter is not user-configurable. Certificate de-duping is configured on a certificate collection using the DuplicationField parameter (see POST Certificate Collections). This corresponds to the Keyfactor Command Management Portal Ignore renewed certificate results by option on a certificate collection. Certificate collections may be configured to be de-duplicated based on the certificate common name, distinguished name, or principal name (or not at all). Only certificates that share all the EKUs (for example, Client Authentication and Server Authentication) as well as the same CN, DN or UPN will be eliminated as duplicates. If a certificate has more than one EKU and at least one EKU does not match an otherwise similar certificate with matching CN, DN or UPN, it will not be eliminated. |
| Uses Collection | A Boolean that indicates whether the report uses a certificate collection as input for reporting (True or False). |
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 workflow 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.Was this page helpful? Provide Feedback