Claim transformation reports

Overview

The Claim transformation reports feature generates in-depth reports detailing the usage of specific claim transformations. This feature is particularly beneficial for users who need to understand how claim transformations are used, which is crucial when considering the deletion of a claim transformation. The downloadable report simplifies the process of identifying and managing transformations efficiently.

Prerequisites

Users must have one of the following roles to access this feature: Administrator, ConfigurationObserver, ConfigurationContributor, ClaimTransformationObserver, or ClaimTransformationContributor.

Generating claim transformation reports

Using Identify Admin

To generate a claim transformation reports via Identify Admin:

  1. Visit the Claim Transformations page.

  2. Select the "Generate claim transformation usage report" button.

    genrate_claim_transformation_report_action.png

  3. A JSON file will be automatically downloaded to your device.

    downloaded_claim_transformation_report.png

The JSON file is named following the pattern: <claim_transformation_name>_report_<timestamp>.json

The JSON file that is downloaded contains detailed information about the usage of the claim transformation. It includes the following fields:

  • ClaimTransformationName: The designated name of the claim transformation.
  • ClaimTransformationContexts: An array of objects, each delineating a context where the claim transformation is implemented. These objects contain:
    • Resource: The resource applying the claim transformation.
    • AdminEndpoint: The Admin UI URL for accessing the resource directly.
    • RestApiEndpoint: The endpoint for accessing the resource using the REST API.

Example report:

downloaded_claim_transformation_report_result.png

Using the REST API

claim_transformation_report_swagger.png

Use the following URL structure to request a claim transformation report via the REST API:

GET https://<your_domain>/admin/api/rest/v2/transformations/transformationreports/{claimTransformationName}

URI parameters:

Parameter Description Data Type Parameter Type
claimTransformationName Name of the claim transformation string path

Request example:

GET https://identify01/admin/api/rest/v2/transformations/transformationreports/Scripting01

Note: You need to URL encode the claim type parameter.

The response body contains the same information as in the JSON file.