$fn.removeUsers(param)

アプリケーションの認可グループから登録しているユーザを除外します。[非同期]

ノート

• 非同期関数であるため、コール時にawait式が必要になります。
• グループからのユーザ削除は１回につき最大100人までにしてください。
  それ以上のユーザを指定した場合は、実行時にエラーが発生し、グループに所属しているユーザ数がずれる場合があります。
  100人を超えるユーザをグループから削除する場合は、分割して削除をしてください。

引数

名前	型	説明
param	object	グループ名と除外するユーザ情報

param詳細

プロパティ	型	説明
groupName	string	グループ名
emails	array of string	グループから除外するユーザのメールアドレス配列

戻り値

なし

サンプル

try {
  /* CSV の内容
   * ---------------------------
   * "email"
   * "user01@test.co.jp"
   * "user02@test.co.jp"
   * ---------------------------
   */
    const file = await $fn.getFile('/removeUsers.csv');
    const buffer = file.data;
    const addUsers = $fn.csvToObject(buffer);
    const emails = addUsers.map(function (item) {
        return item['email'];
    });
    // 認可グループ「Group01」からユーザ除外
    await $fn.removeUsers({
    groupName: "Group01",
    emails: emails
 });
} catch(err) {
 console.log("Error", err);
}