Inactive user reports

Overview

The Inactive user reports feature allows users to track accounts that have not logged in within a specified timeframe. This feature helps efficient account management by providing insights into inactive accounts, which can then be reviewed for potential removal.

Prerequisites

  • Users must have one of the following roles to access this feature: Administrator, UserObserver, or UserContributor.
  • The Save user's last sign-on date setting on the Settings page must be set to YES. This ensures that data about the last login is only available for users who have logged in after this setting is enabled.

save-user-last-signon

Generating inactive user reports

Using Identify Admin

To generate an inactive user report via Identify Admin:

  1. Go to the Users page.

  2. Click on the "Inactive user report" button.

genrate_inactive_user_report_action.png

  1. The "Inactive user report" dialog will appear, prompting you to enter the following information:

inactive_user_report_dialog.png

  • Days Since Last Login: Enter the number of days since the user last logged in (integer; default is 1).
  • Maximum Number of Users to Retrieve: Set the limit for the number of inactive users to report (integer; default is 100).
  • Excluded Organizations: Specify any organizations whose users should be omitted from the report.
  • Include Disabled Users: Choose whether to include disabled users in the report (default is false).

  1. Click "REPORT" button to generate the report.

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

downloaded_claim_report.png

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

The downloaded JSON file contains detailed information about the inactive users, including fields such as totalRecords, sortBy, sortOrder, daysSinceLastLogin, and a resources array with individual user data:

  • totalRecords: Represents the total number of inactive users in the report.

  • sortBy: Represents the attribute by which the records are sorted. The report is sorted by the lastLoggedInDateTime attribute of the inactive user.

  • sortOrder: Represents the order in which the records are sorted. The sort order is Descending, meaning the records with the latest lastLoggedInDateTime come first.

  • daysSinceLastLogin: Represents the number of days from the current time forward that the user has not logged in.

  • resources: This is a collection (array) of inactive users, each representing a inactive user user information based on input values provided in Inactive user report dialog.

    downloaded_inactive_user_report_result.png

Using the REST API

inactive_user_report_swagger.png

Request URL:

GET https://<your_domain>/admin/api/rest/v2/users/inactiveusers

URI parameters:

Parameter Description Data Type Parameter Type
pageIndex Page index to return. Defaults to 1 if input is 0 or invalid. integer query
pageSize Page size to return. Defaults to 1000 if input is 0 or invalid, with a maximum value of 1000. integer query
daysSinceLastLogin Number of days since the last login; must be a positive integer. integer query
includeDisabledUsers Whether to include disabled users; default is false. boolean query
excludedOrganizations Comma-separated list of organization names to exclude. string query

Request example:

GET https://identify01/admin/api/rest/v2/users/inactiveusers?pageIndex=1&pageSize=100&daysSinceLastLogin=1&includeDisabledUsers=false&excludedOrganizations=c93eb3cb-5e5a-4407-956a-f4dc08722beb,55ecd304-6d99-45d4-98aa-6eb6bcb3ba42

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

Data Privacy

Inactive user reports exclude users' claims marked as Sensitive to protect personal details and adhere to privacy best practices. Our system ensures data collection and usage respect user privacy.