Skip to main content
Version: 26.1

Reports

Generate reports using templates created by Project editors and Project admins. These templates consist of standardized questions with attribute placeholders that you populate when running a report.

When you access the Reports section, a comprehensive list of all existing reports displays. This view provides key information at a glance, including:

Description
NameThe name of a report serving as a label.
DescriptionA brief overview of the report's purpose and usage.
Updated byThe Authorization Hub user or M2M client that updated the report last.
Last updatedThe date and time of the last update performed on the report.

Additionally, you can refine the reports list using the following features:

  • Filter: Use the filter field to refine and narrow down the displayed reports. You can enter a report name, a part of a description, or a 'created by' entry.

    note

    This is a dynamic search field and returns relevant results as you type.

  • Sorting: Click the header of a column to sort its contents.

Create a report

Follow the steps below to create a new report by utilizing one of the available templates.

  1. Click + Add new.

  2. In the Name field, enter a unique name for the report.

  3. Optionally, in the Description field, enter details about the report's purpose.

  4. From the Environment dropdown, select the target environment for the report.

    tip

    An Environment represents a specific CAQ runtime endpoint, consisting of a deployed authorization engine instance and its associated domain.

  5. From the Template dropdown, select one of the available templates.

    The template's question will display below.

  6. Populate the placeholders within the question with the required attribute values.

    Depending on the template configuration, input modes may vary. You may be required to:

    • Type one or more values directly into the field

      If supported by the configuration, add multiple values by pressing Enter ↵ after each entry.

    • Select one or more values from a dropdown

      If supported by the configuration and the required value is not on the dropdown, type it into the search field at the top of the list and click + Add "...".

  7. Click Run to generate the report.

    The results appear immediately below.

  8. Click Add to save the report to the list, or click Cancel to exit without saving.

    note

    This action also saves the latest results as part of the report history for future reference.

Date and time input formats notice

The supported formats for date and time placeholders are the following:

Placeholder typeFormatExample
dateYYYY-MM-DDZ2025-01-01Z
dateTimeYYYY-MM-DDTHH:mm:ssZ2025-02-14T23:00:00Z
timeHH:mm:ssZ17:00:00Z

Entering an invalid date/time format may result in a request failure such as a 500 error.

Manage reports

Perform several actions to existing reports by clicking the three dots on the far right of each entry and selecting from:

  • Edit

    1. Apply the necessary changes.

    2. Click Run to generate the report using the updated values.

  • Delete

    Confirm your action in the displayed pop-up by clicking Yes, delete.

    Important

    This action is permanent and cannot be undone.