cybozu.com 共通 API ドキュメント

グループに所属するユーザーを更新する

目次

グループに所属するユーザーを更新する

グループに所属するユーザーを更新します。

CSV ファイルをインポートする API はありません。

URL

https://sample.cybozu.com/v1/group/users.json

HTTP メソッド

PUT

必要なアクセス権

リクエスト

パラメーター
パラメーター名 型 必須 説明
code 文字列 必須 グループコード
128 文字以下で指定します。
動的グループは指定できません。
users 配列（文字列） 必須 グループに所属するユーザーのログイン名の一覧
最大 1,000 件まで指定できます。
グループに所属するユーザーを更新するときは、すでに指定しているログイン名もすべて指定してください。
指定していないと、所属グループから削除されます。
グループに所属するユーザーをすべて解除するには、空配列を指定してください。
リクエストの例
ヘッダー
1
2
3
4

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU=",
  "Content-Type": "application/json"
}

リクエストヘッダーの詳細は User API の共通仕様 を参照してください。

ボディ
1
2
3
4

{
  "code": "group1",
  "users": ["user1", "user2", "user3"]
}

レスポンス

1

{}
制限事項
  • API の実行と同時に、画面から登録／編集したり CSV ファイルをインポートしたりした場合には、書き込まれた順に処理されます。
  • この API では、処理のロックを行っていません。
    そのため、画面からの登録／編集、CSV ファイルのインポート、API での操作を並行して行うことを推奨していません。