開発者向け機能：サーバスクリプト：groups.Update

概要¶

サーバスクリプトで指定したグループIDのグループを更新します。

前提条件¶

本機能によるグループの更新にはサイトの管理者権限が必要です。サイトの管理者権限がないユーザで更新したい場合、サイトの管理権限をもったユーザのAPIキーの指定が必要です。

構文¶

groups.Update(groupId, data)

パラメータ¶

戻り値¶

指定したグループが更新できた場合には true、更新できなかった場合には false を返却します。

使用例¶

下記の例では、グループ 100 のグループのメンバーをユーザID 5 のユーザ、組織ID 3 の組織で更新します。メンバーがユーザの場合は "User,ユーザID,管理者権限(true/false)"、組織の場合は "Dept,組織ID,管理者権限(true/false)" を指定してください。メンバーの更新は指定したもので全て洗い替えとなります。

JavaScript¶

const apiKey = 'xxxxx...';
const userId = 5;
const deptId = 3;
const groupId = 100;
let groupMembers = [
    `User,${userId},true`,
    `Dept,${deptId},false`
];
const data = {
    ApiKey: apiKey,
    GroupMembers: groupMembers
};
groups.Update(groupId, JSON.stringify(data));

関連情報¶

• 開発者向け機能：サーバスクリプト
• グループ管理機能
• テーブルの管理：エディタ：項目の詳細設定：選択肢一覧：ユーザ
• 組織管理機能