Box Developerドキュメント
ログイン

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

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

必須のガイド

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

このスクリプトは、一定の日数の間非アクティブであったユーザーのリストを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 CLI

スクリプトを使用するには、Box CLIをインストールし、構成する必要があります。これは、クイックスタートガイドの手順を実行することで行うことができます。ログインに使用するユーザーは、Boxのメイン管理者または共同管理者である必要があります。

スクリプトの構成

  1. boxcli GitHubリポジトリを複製してこの例のフォルダにcdコマンドで移動するか、examplesディレクトリからファイルをダウンロードします。
    git clone https://github.com/box/boxcli.git
    cd boxcli/examples/Inactive\ Users\ Report/
  1. スクリプトでUser Eventをスキャンする日数を設定します。この値を指定しなかった場合やデフォルト設定のままにした場合は、スクリプトによって入力するよう求められます。
    $daysInactive = "10"
  1. (省略可) レポート出力ファイル名を変更するには、ReportOutputFileパラメータを定義します。
    $ReportOutputFile = $ReportName + ".csv"
  1. (省略可) イベントタイプを変更するには、eventTypeパラメータのリストを定義します。
    $eventType = "LOGIN,UPLOAD,COPY,MOVE"

スクリプトの実行

PowerShellコマンドを実行します。

pwsh

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

./Inactive_Users_Report.ps1

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

Transfered employee content Managed User 1
with User ID: 19927131476 to Employee Archive Folder
Deleted user 19927131476
Deleted employee Managed User 1

ログ

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

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