The PUT /Reports/Custom method is used to update the custom report link with the specified ID. This method returns HTTP 200 OK on a success with the details of the report linkage.
Tip: The following permissions (see Security Roles and Claims) are required to use this feature:
/reports/modify/
Table 600: PUT Reports Custom Input Parameters
| Name | In | Description |
|---|---|---|
| CustomURL | Body | Required. A string containing the URL users should click from within Keyfactor Command to display the custom report (e.g. https://mywebserver.keyexample.com/mycustomreport/). Tip: Custom reports are automatically opened in a new browser tab. |
| Id | Body |
Required. An integer containing the Keyfactor Command reference ID for the report link. Use the GET /Reports/Custom method (see GET Reports Custom) to retrieve a list of your custom report links to determine the report ID to use. |
| DisplayName | Body | Required. A string containing the display name for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page and on the menu. |
| Description | Body | A string containing the description for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page. |
| InNavigator | Body | A Boolean that indicates whether the report has been configured to display on the Keyfactor Command Management Portal menu (true) or not (false). |
| Favorite | Body | A Boolean that indicates whether the report has been marked as a favorite (true) or not (false). |
Table 601: PUT Reports Custom Response Data
| Name | Description |
|---|---|
| CustomURL | A string containing the URL users should click from within Keyfactor Command to display the custom report (e.g. https://mywebserver.keyexample.com/mycustomreport/). Tip: Custom reports are automatically opened in a new browser tab. |
| Id |
An integer containing the Keyfactor Command reference ID for the report link. |
| DisplayName | A string containing the display name for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page and on the menu. |
| Description | A string containing the description for the report. This appears in the Keyfactor Command Management Portal on the Report Manager page. |
| InNavigator | A Boolean that indicates whether the report has been configured to display on the Keyfactor Command Management Portal menu (true) or not (false). |
| Favorite | A Boolean that indicates whether the report has been marked as a favorite (true) or not (false). |
Tip: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API
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. endpoints can be called and results returned. It is intended to be used primarily 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. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon (
) at the top of the Management Portal page next to the Log Out button.
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. endpoints can be called and results returned. It is intended to be used primarily 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. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon () at the top of the Management Portal page next to the Log Out button.