グループとコラボレーションの管理

​

スクリプト構造

​

グループの作成または更新

1. このスクリプトでは、UserGroupAdditionPathパラメータに指定した.csvファイルを使用します。このファイルには、グループ名とユーザーのメールアドレスが記載されています。このファイルを作成する際には、複数のユーザーに同じグループ名を使用することも、1人のユーザーを複数のグループに割り当てることもできます。以下に例を示します。

   GroupName	UserEmail
   Group1	ManagedUser1@test.com
   Group1	ManagedUser2@test.com
   Group2	ManagedUser3@test.com
   Group3	ManagedUser1@test.com

2. グループが存在しない場合は、スクリプトによってそのグループが作成されます。グループが存在する場合は、指定したデータに基づいてエントリが更新されます。

​

コラボレーションの作成または更新

1. このスクリプトでは、CollaborationsCreationPathパラメータに指定した.csvファイルを使用します。このファイルには、グループ名、フォルダID、コラボレーションロールが記載されています。
2. スクリプトでは、行ごとに、グループが存在するかどうか、そのグループがすでに対応するフォルダにコラボレータとして追加されていないかどうかを確認します。以下に例を示します。

   GroupName	FolderId	CollaborationRole
   Group1	1111111	editor
   Group2	1111111	viewer_uploader
   Group2	2222222	viewer
   Group3	1111111	viewer_uploader

3. 両方の条件を満たしている場合、CollaborationRole列で定義されたロールを使用してグループがフォルダに割り当てられます。また、グループはすでに存在していても、CollaborationRoleを変更した場合、スクリプトの実行時に-UpdateExistingCollabsフラグを渡すと、コラボレーションロールが更新されます。

​

前提条件

​

Windows

​

macOSおよびLinux

pwsh

PowerShell 7.2.5
Copyright (c) Microsoft Corporation.

https://aka.ms/powershell
Type 'help' to get help.

PS /Users/user/repos/boxcli/examples>

​

Box CLI

​

スクリプトの構成

1. boxcli GitHubリポジトリを複製してこの例のフォルダにcdコマンドで移動するか、examplesディレクトリからファイルをダウンロードします。
   git clone https://github.com/box/boxcli.git boxcli
   cd boxcli/examples/Mass\ Groups\ \&\ Collaborations\ Update/
   
2. グループとユーザーのメールアドレスのリストが含まれる.csvファイルのパスを設定します。
   $UserGroupAdditionPath = "./User_Group_Addition.csv"
   
   • UserEmailは、Boxにおけるこのユーザーのプライマリメールアドレスです。
   • GroupNameは、グループの名前です。
3. グループとユーザーのメールアドレスのリストが含まれる.csvファイルに独自のパスを設定します。
   $CollaborationsCreationPath = "./Collaborations_Creation.csv"
   
   • GroupNameは、スクリプトによってフォルダにコラボレータとして追加されるグループの名前です。
   • FolderIdは、コラボレータの追加先となるフォルダIDです。
   • CollaborationRoleは、コラボレーションの作成時に使用されるロールの名前です。
   使用可能なロールを設定するには、AvailableCollaborationRolesパラメータを設定します。
   $AvailableCollaborationRoles = @("editor", "viewer", "previewer", "uploader", "previewer_uploader", "viewer_uploader", "co-owner")
   

​

スクリプトの実行

1. PowerShellコマンドを実行します。
   pwsh
   
2. スクリプトを実行します。
   ./Mass_Groups_Collabs_Update.ps1
   

​

オプションのフラグ

• グループがすでに特定のフォルダのコラボレータとして設定されているものの、その役割が.csvファイルで定義されたものとは異なる場合は、スクリプトによってそのことが通知されます。スクリプトによって既存のコラボレーションが変更されることはありません。.csvファイルで定義された役割で既存のコラボレーションを更新するには、スクリプトを実行する際に追加の-UpdateExistingCollabsフラグを設定します。
  Mass_Groups_Collabs_Update.ps1 -UpdateExistingCollabs
  
• コラボレーションを作成せずにグループを更新するには、スクリプトの実行時に-SkipCollabsCreationブール値フラグを追加します。
  Mass_Groups_Collabs_Update.ps1 -SkipCollabsCreation
  
• グループを更新せずにコラボレーションを作成するには、スクリプトの実行時に-SkipGroupsUpdateブール値フラグを追加します。
  Mass_Groups_Collabs_Update.ps1 -SkipGroupsUpdate
  

​

ログ

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