> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Report inactive users
export const MultiRelatedLinks = ({sections = []}) => {
if (!sections || sections.length === 0) {
return null;
}
return
;
};
export const Link = ({href, children, className, ...props}) => {
const localizedHref = href;
return
{children}
;
};
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 [.NET core](https://dotnet.microsoft.com/download).
### macOS & Linux
Install [PowerShell][pwsh]. Run the `pwsh` command to test the installation.
```bash theme={null}
pwsh
```
Depending on the directory you are
running the command in, the output may differ.
For example:
```bash theme={null}
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
[.NET core](https://dotnet.microsoft.com/download) and
[PowerShell][pwsh].
### Box CLI
To use the script, you need the Box CLI
installed and configured. You can do this by following
our quick start guide. The user you use to login with should
be the main Box admin or co-admin.
## Configure the script
1. Clone the `boxcli` GitHub repository and cd into this example's folder or download the files from the [`examples`][examples] directory.
```bash theme={null}
git clone https://github.com/box/boxcli.git
cd boxcli/examples/Inactive\ Users\ Report/
```
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.
```bash theme={null}
$daysInactive = "10"
```
3. (Optional) To change the report output file name, define the `ReportOutputFile` parameter.
```bash theme={null}
$ReportOutputFile = $ReportName + ".csv"
```
4. (Optional) To change event types, define the list for `eventType` parameter.
```bash theme={null}
$eventType = "LOGIN,UPLOAD,COPY,MOVE"
```
## Run the script
Run the Powershell command.
```bash theme={null}
pwsh
```
Run the script.
```bash theme={null}
./Inactive_Users_Report.ps1
```
When the script run is completed, you will see the following
output or a similar one.
```bash theme={null}
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` - contains all log entries
* `Inactive_Users_Report_errors.txt` - contains only errors.
[scripts]: https://github.com/box/boxcli/tree/main/examples
[pwsh]: https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell?view=powershell-7.2
[console]: https://app.box.com/developers/console
[auth]: /guides/authentication/oauth2/oauth2-setup
[examples]: https://github.com/box/boxcli/tree/main/examples/Inactive%20Users%20Report