Claim definition reports

Overview

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

Prerequisites

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

Generating claim reports

Using Identify Admin

To generate a claim usage report via Identify Admin:

  1. Go to the Claims page.

  2. Click the "Generate claim usage report" button.

    genrate_claim_report_action.png

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

    downloaded_claim_report.png

The downloaded JSON file is named in the format: <claim_type>_report_<timestamp>.json

This file provides detailed insights into the claim type's application, including fields such as:

  • ClaimType: The specific claim type addressed in the report.
  • ClaimUsageContexts: An array of objects, each representing a context where the claim type is used. These objects include:
    • SettingField: The setting where the claim type is employed.
    • Resource: The resource name applying the claim type.
    • 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_report_result.png

Using the REST API

claim_report_swagger.png

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

GET https://<your_domain>/admin/api/rest/v2/claimdefinitions/claimreports/{claimType}

URI parameters:

Parameter Description Data Type Parameter Type
claimType A claim type (claim definition) string path

Request example:

GET https://identify01/admin/api/rest/v2/claimdefinitions/claimreports/http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name

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

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