ユーザーのプロビジョニング解除とフォルダのアーカイブ

ガイド CLI CLIサンプルスクリプト ユーザーのプロビジョニング解除とフォルダのアーカイブ

ユーザーのプロビジョニング解除とフォルダのアーカイブ

このスクリプトを使用すると、ユーザーのリストによるプロビジョニング解除と削除が可能です。スクリプトでは以下の手順が実行されます。

  1. Transfers the user content to the another user's root folder under Employee Archive.
  2. ユーザーを削除します。

前提条件

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 CorePowerShellの両方をインストールしたかどうか確認してください。

Boxアプリケーション

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

スクリプトの構成

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

git clone https://github.com/box/boxcli.git

従業員のリストが含まれるCSVファイルのパスを指定します。

$EmployeeList = "./Employees_to_delete.csv"

削除対象の従業員アカウントが記載されたEmployees_to_delete.csv入力ファイルを、削除対象アカウントのメールアドレスを指定してカスタマイズします。以下に例を示します。

name,email
Managed User 1,ManagedUser1@test.com

To set the user ID which will be the new owner of user content before deleting the user, set the NewFilesOwnerID parameter to the user ID you want. If no value is provided before running the script, it will prompt you to provide one or press Enter to use the user ID of the currently authenticated user.

(省略可) ユーザーの削除前にユーザーコンテンツの転送をスキップするには、TransferContentパラメータをNに設定します。

$TransferContent = "N"

(省略可) EmployeeArchiveFolderNameを任意の名前に変更します。

$EmployeeArchiveFolderName = "Employee Archive"

スクリプトの実行

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

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

https://aka.ms/powershell
Type 'help' to get help.
  
PS /home/rvb/box-cli/examples/User Deprovisioning>

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

./Users_Deprovision.ps1

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

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

オプションのフラグ

To run the script in a simulation mode, add the DryRun boolean flag. Dry run doesn't mean that API calls won't be made, but that create, update, or delete calls will be skipped.

./Users_Deprovision.ps1 -DryRun

To set the new files owner ID at runtime, add the NewFilesOwnerID string flag. It will overwrite the value specified in the script before.

./Users_Deprovision.ps1 -NewFilesOwnerID 12345

ログ

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

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

[employeelist][employeelist]:[https://github.com/box/boxcli/blob/main/examples/User%20Deprovisioning/Users_Deprovision.ps1#L12