Box開発者向けドキュメントポータル
ログイン

非アクティブなユーザーのレポート

ガイド CLI CLIサンプルスクリプト 非アクティブなユーザーのレポート

required_guides

非アクティブなユーザーのレポート

このスクリプトは、一定の日数の間非アクティブであったユーザーのリストをCSVファイルで生成します。スクリプトによって以下の手順が実行されます。

  1. userロールを持つユーザーを探します。

    このスクリプトでは、他のロール (AppUserなど) は考慮していません。

  2. Box Eventsを使用して、そのユーザーが一定の日数の間に操作を行ったかどうかを確認します。
    デフォルトのイベントタイプのリストは、LOGIN、UPLOAD、COPY、MOVE、PREVIEW、DOWNLOAD、EDIT、DELETE、UNDELETE、LOCK、UNLOCK、NEW_USERです。このリストはスクリプトの設定で変更できます。
  3. 操作を行わなかったユーザーを、非アクティブなユーザーが含まれている.csvファイルに追加します。このファイルは他のスクリプト (ユーザーのプロビジョニング解除など) の入力として使用できます。

前提条件

Windows

.NET Coreの最新バージョンのインストール

MacOSおよびLinux

PowerShellをインストールします。pwshコマンドを実行して、インストール結果をテストします。

pwsh

どのディレクトリでこのコマンドを実行するかに応じて、出力が異なる場合があります。以下に例を示します。

PowerShell 7.2.5
Copyright (c) Microsoft Corporation.

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

問題が発生する場合は、.NET CoreとPowerShellの両方をインストールしたかどうか確認してください。

Boxアプリケーション

スクリプトを使用するには、OAuth 2.0認証を使用するBoxアプリケーションが必要です。該当するアプリケーションがない場合は、開発者コンソールに移動して、OAuth 2.0を使用した設定ガイドに従ってください。

スクリプトの構成

  1. boxcli GitHubリポジトリを複製するか、examplesディレクトリからファイルをダウンロードします。

    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.

   ```bash
$daysInactive = "10"

  1. (省略可) レポート出力ファイル名を変更するには、ReportOutputFileパラメータを定義します。

    $ReportOutputFile = $ReportName + ".csv"

4. (Optional) To change event types, define the list for `eventType` parameter.

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

スクリプトの実行

ディレクトリを、スクリプトが格納されているフォルダに変更します。この例では、Inactive Users Reportフォルダになります。

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>

スクリプトを実行します。

./Inactive_Users_Report.ps1

スクリプトの実行が完了すると、以下のような出力が表示されます。

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

ログ

ログは、メインフォルダ内のlogsフォルダに格納されます。以下のログファイルにアクセスできます。

  • Inactive_Users_Report_all.txt: すべてのログエントリが含まれています。
  • Inactive_Users_Report_errors.txt: エラーのみが含まれています。