Box CLIでのPowerShellスクリプトの使用

​

ユースケース

1. .csvファイルを使用して従業員データを一括で読み込みます。
2. JSONファイルを使用してフォルダ構造を定義するか、ユーザーのローカルディレクトリから構造をアップロードします。
3. 新しい管理対象ユーザーごとに、あらかじめ決められた個人用フォルダ構造を作成します。

​

前提条件

​

Windows

​

macOSおよびLinux

​

Box CLI

​

個人用フォルダの親フォルダの作成

​

スクリプトのダウンロード

git clone https://github.com/box/boxcli.git box-cli
cd box-cli/examples/User\ Creation\ \&\ Provisioning/

​

スクリプト設定の構成

​

パラメータの指定

• EmployeeList: Employee List CSVのパス。
• PersonalFolderParentID: 入力にJSONファイルを使用してフォルダ構造を作成するかローカルの構造をアップロードするときに、すべての個人用フォルダが作成される宛先フォルダID。このフォルダは、初めてスクリプトを実行する前に作成する必要があります。この値を0にすることはお勧めしません。この値に設定した場合、CLIの設定に使用したアカウントのルートに個々の個人用フォルダが作成されるためです。
• FolderStructureJSONPath: 所有するフォルダ構造のJSONパス。
• PersonalFolderSlug: 個人用フォルダの親として作成されるフォルダ名の末尾に使用される文字列。デフォルトではPersonal Folderに設定されていますが、必要に応じて自由に設定できます。ユーザー名とこの値を組み合わせて、各ユーザーの個人用フォルダの名前が作成されます (例: rsmith2's Personal Folder)。
• LocalUploadPath: フォルダ構造を直接アップロードするためのローカルディレクトリ。

​

ユーザーリストの更新

firstName,lastName,email,username
Isaac,Newton,abc@abc.local,INewton23

​

フォルダ構造の作成

​

JSONファイルを使用する

​

ローカルドライブからアップロードする

​

パラメータの更新

• スクリプトで静的な値を使用する
  実行する前に、スクリプト内のすべての必須パラメータを忘れずに更新してください。
  # Set Employee List CSV Path
  # firstname, lastname, email, username
  $EmployeeList = ""
  
  # Personal Folder Structure: Set either path build off JSON or directly upload
  # a local folder
  $FolderStructureJSONPath = ""
  $LocalUploadPath = ""
  
  # Ending slug of folder that will be used in creating personal folders for new
  # users. Value will get concatenated with username
  # If username is RSMITH, the personal folder name would be
  # RSMITH's Personal Folder
  $PersonalFolderSlug = ""
  
  # ID of parent folder for created personal folders to be created in
  # This folder should be created before running the script the first time.
  # It is not advised to make this value 0, as this will create individual
  # Personal folders in root of the account you set up the cli with
  $PersonalFolderParentID = ""
  
• パラメータを指定してスクリプトを実行する スクリプトの実行中にパラメータを指定できます。以下に例を示します。
  PS > ./Users_Create_Provision.ps1 -EmployeeList ./Employees_1.csv `
      -LocalUploadPath ./PersonalLocalUpload `
      -PersonalFolderSlug "Personal Folder" `
      -PersonalFolderParentID 123456789
  
  Starting User Creation & Provisioning script...
  
• 求められたときにパラメータを指定する 実行時に指定されていないパラメータがある場合は、スクリプトにより、指定するよう求められます。
  PS > ./Users_Create_Provision.ps1
  Please enter the path to the employee list CSV file:
  ./Employees_1.csv
  Please enter the path to the folder structure JSON file or the local upload path:
  Folder_Structure.json
  Folder structure JSON path set to: Folder_Structure.json
  Please enter the ID of the folder where you would like to create the personal folders:
  0
  Starting User Creation & Provisioning script...
  

​

スクリプトの実行

1. ディレクトリを、スクリプトが格納されているフォルダに変更します。この例では、User Creation & Provisioningフォルダになります。
   pwsh
   
2. スクリプトを実行します:
   PS /home/rvb/box-cli/examples/User Creation & Provisioning> ./Users_Create_Provision.ps1
   
   レスポンスは以下のようになります。
   Starting User Creation & Provisioning script...
   
   firstName lastName email
   --------- -------- -----
   Isaac     Newton   abc@abc.local
   Extracting folder structure
   Found current User ID: 18622116055
   
   Created a user owned Onboarding folder with id: 164734146745
   
   Created subfolder Market Research under Onboarding folder with id: 164735375585
   
   Created subfolder under Statistics folder with id: 164734956242
   
   Created subfolder Sales Plays under Onboarding folder with id: 164735683001
   
   Created subfolder under Big Pharma folder with id: 164736160637
   Creating employee Managed User account with first name:
   Isaac, last name: Newton, email: abc@abc.local, and
   
   Created Managed user with id: 19605663027
   
   Type: collaboration
       ID: '37250833128'
   Created By:
       Type: user
       ID: '18622116055'
   Name: Rui Barbosa
   Login: barduinor@gmail.com
   Created At: '2022-06-07T13:58:05-07:00'
   Modified At: '2022-06-07T13:58:05-07:00'
   Expires At: null
   Status: accepted
   Accessible By:
       Type: user
       ID: '19605663027'
       Name: Isaac Newton
       Login: abc@abc.local
   Invite Email: null
   Role: viewer uploader
   Acknowledged At: '2022-06-07T13:58:05-07:00'
   Item:
       Type: folder
       ID: '164734146745'
       Sequence ID: '0'
       ETag: '0'
   Name: Onboarding
   Collaborated Managed User Isaac Newton to current users
   Onboarding folder for provisioning
   

​

新規ユーザーに対するスクリプトの再実行

​

まとめ