開発者向け機能:サーバスクリプト:users.Update
概要¶
サーバスクリプトで指定したユーザを更新します。
メソッド¶
パラメータ¶
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
| userId | long | ○ | 更新対象のユーザIDを指定します。 |
| user | string | ○ | 更新するユーザ情報をJSON形式の文字列で指定します。指定内容は「JSONデータレイアウト:User」を参照してください。 |
使用例¶
下記の例ではユーザID 11 の氏名、組織、拡張項目を更新します。
const userId = 11;
const data = {
Name: '田中太郎',
DeptId: 3,
ClassHash: {
ClassA: 'test-class-column'
},
NumHash: {
NumA: 100
},
DateHash: {
DateA: '2026-08-19'
},
DescriptionHash: {
DescriptionA: '補足説明'
},
CheckHash: {
CheckA: true
}
};
users.Update(userId, JSON.stringify(data));
戻り値¶
ユーザの更新に成功した場合は true、失敗した場合は false を返します。
注意事項¶
こちらは「サーバスクリプト」で使用するメソッドです。「スクリプト」では使用できません。
対応バージョン¶
| 対応バージョン | 内容 |
|---|---|
| 1.5.8.0 以降 | 機能追加 |
