Report inactive users

Report inactive users

This script generates a CSV file with a list of users who have been inactive for a number of days. It performs the following steps:

  1. Looks for the users who have the role user.

    The script does not consider other roles, such as AppUser.

  2. Uses Box Events to check if the user performed any actions
    for a specified number of days. The default list of event types includes: LOGIN,UPLOAD,COPY,MOVE,PREVIEW,DOWNLOAD,EDIT,DELETE,UNDELETE,LOCK,UNLOCK, NEW_USER. You can modify this list in the script settings.
  3. Adds users who didn't perform any actions to a .csv file with inactive users. You can use this file as input for other scripts, for example to deprovision users.

Prerequisites

Windows

Install the latest version of dotnet core.

MacOS & Linux

Install PowerShell. Run the pwsh command to test the installation.

pwsh 

Depending on the directory you are running the command in, the output may differ. For example:

PowerShell 7.2.5
Copyright (c) Microsoft Corporation.

https://aka.ms/powershell
Type 'help' to get help.
  
PS /Users/user/repos/boxcli/examples> 

If you encounter issues make sure you installed both dotnet core and PowerShell.

Box application

To use the script, you will need a Box application with OAuth 2.0 authentication. If you don't have one, go to your Developer Console, and follow the guide Setup with OAuth 2.0.

Configure the script

  1. Clone the boxcli GitHub repository or download the files from examples directory.

    git clone https://github.com/box/boxcli.git
    
  2. Set the number of days you want the script to scan for user events. If you don't specify this value or leave the default, the script will prompt you to enter it.

    $daysInactive = "10"
    
  3. (Optional) To change the report output file name, define the ReportOutputFile parameter.

    $ReportOutputFile = $ReportName + ".csv"
    
  4. (Optional) To change event types, define the list for eventType parameter.

    $eventType = "LOGIN,UPLOAD,COPY,MOVE"
    

Run the script

Change the directory to the folder containing the script. In this example, it is the Inactive Users Report folder.

rvb@lab:~/box-cli/examples/Inactive Users Report$ pwsh
PowerShell 7.2.4
Copyright (c) Microsoft Corporation.

https://aka.ms/powershell
Type 'help' to get help.

PS /home/rvb/box-cli/examples/Inactive Users Report>

Run the script.

./Inactive_Users_Report.ps1

When the script run is completed, you will see the following output or a similar one.

Looking for users inactive for more than 3 days.
Found 6 users.
Found 7 events in last 3 days
Enterprise has: 0 App user, 6 regular users. With 1 admin role, 5 user roles.
Need to check 5 users (regular user, with user role) for inactive.
Found 5 users inactive for more than 3 days.
Report is available at InactiveUsers.csv

Logging

Logs are stored in the logs folder located in the main folder. You have access to these log files:

  • Inactive_Users_Report_all.txt that contains all log entries
  • Inactive_Users_Report_errors.txt that contains only errors.