Templates

Templates are reusable blueprints for queries that are used to generate access review reports. They are structured as standardized questions with attribute placeholders that you fill in right before running a report.

When you access the Templates section, a comprehensive list of all available templates displays. This view provides key information at a glance, including:

	Description
Name	The name of a template serving as a label.
Description	A brief overview of the template's purpose and usage.
Reference attributes from	The source (project or domain) of the attributes used in the template.
Updated by	The Authorization Hub user or M2M client that updated the template last.
Last updated	The date and time of the last update performed on the template.

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

• Filter: Use the filter field to refine and narrow down the displayed templates. You can enter a template 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.

• Column selection: Use the column selector above the list to choose which columns display. The Name and actions columns cannot be hidden. Your selection is remembered for this list in your browser, but it is not shared with other browsers, devices, or users. Use the reset option to return to the default columns.

Create a template

Follow the steps below to create a new template and define the question displayed when running a report.

note

Only a single question (query) per template is supported.

1. Click + Add new.

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

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

4. From the Reference attributes from dropdown, select a project or domain. This becomes the attribute source for the question in this template. All attributes declared within the selected source appear in the list below.

   tip

   In the Attribute connectors column, the attribute mapping icon shows which attribute connectors supply that attribute to the authorization engine to retrieve its values.

5. Define the question:

   1. Type the question that will be answered when running a report using this template.

   2. Click Insert attribute to embed an attribute in the question. A popup displays.

      1. From the Attribute name dropdown, select an attribute.

      2. In the Display label field, enter a user-friendly label.

         This label appears as part of the question text.

      3. Select an Input mode.

         • Provided by user: the user running the report provides the attribute values directly.

           Optionally, select Allow multiple values to let the user enter more than one value.

           If you also select Run as separate queries, each value triggers a separate query execution. Otherwise, all values are treated as a bag of values within a single query.

         • Suggested values: the user selects from a predefined list.

           1. In the Options field, type an option and press Enter ↵.

              Repeat for each additional option.

           2. Optionally, select Allow custom values to let the user enter values outside the predefined list.

              If you also select Run as separate queries, each value triggers a separate query execution. Otherwise, all values are treated as a bag of values within a single query.

      4. If the attribute is provided by an attribute connector, optionally select Mark as mocked attribute. See Mocked attributes for details.

   3. Click + Add to question to insert the attribute into the question.

   4. Repeat this procedure to add more attributes to the question.

6. Click Save to store your template.

Mocked attributes

By default, when the attribute value is retrieved from an external source, an attribute connector is called to resolve this attribute. Mocking an attribute bypasses the attribute connector and sends the value you supply directly in mockedAttributes in the CAQ request (no key attribute is required).

Use this option to express queries that don't require an entity to exist in your data sources:

• "What can a manager do?"

  Mark the role attribute as mocked (no key attribute is needed).

• "What can Alice, who is a manager, do?" - bypass the attribute connector

  Set the subject key as provided and the role as mocked.

• "What can Alice, who is a manager, do?" - also retrieve from the attribute connector

  Set the subject key as provided and the role as provided.

• "What can Alice do?"

  Set the subject key as provided (no derived attribute needed).

note

When Mark as mocked attribute is left unchecked, the attribute is sent in providedAttributes and the attribute connector is invoked to resolve it.

Manage templates

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

• Edit

  1. Perform all necessary changes.

     note

     Attributes deleted from the Dictionary after template creation are labeled DEPRECATED. Update the affected questions to ensure reports continue to generate successfully.

  2. Click Update.

• Delete

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

  warning

  This action is permanent and cannot be undone.