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:
Looks for the users who have the role
- Uses Box Events to check if the user performed any actions
for a specified number of days. The default list of event types includes:
NEW_USER. You can modify this list in the script settings.
- Adds users who didn't perform any actions to a
.csvfile with inactive users. You can use this file as input for other scripts, for example to deprovision users.
Install the latest version of dotnet core.
MacOS & Linux
Install PowerShell. Run the
pwsh command to test the installation.
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>
To use the script, you will need the Box CLI installed and configured. You can get this done by going through our quick start guide. The user you use to login with should be the main Box admin or co-admin.
Configure the script
boxcliGitHub repository and cd into this example's folder or download the files from
git clone https://github.com/box/boxcli.git cd boxcli/examples/Inactive\ Users\ Report/
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"
(Optional) To change the report output file name, define the
$ReportOutputFile = $ReportName + ".csv"
(Optional) To change event types, define the list for
$eventType = "LOGIN,UPLOAD,COPY,MOVE"
Run the script
Run the Powershell command.
Run the script.
When the script run is completed, you will see the following output or a similar one.
Transfered employee content Managed User 1 with User ID: 19927131476 to Employee Archive Folder Deleted user 19927131476 Deleted employee Managed User 1
Logs are stored in the
logs folder located in the main folder.
You have access to these log files:
Inactive_Users_Report_all.txtthat contains all log entries
Inactive_Users_Report_errors.txtthat contains only errors.