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

ユーザーが所属するグループ（ロール）を更新する

目次

ユーザーが所属するグループ（ロール）を更新する

ユーザーが所属するグループ（ロール）を更新します。

CSV ファイルをインポートする API の詳細は、 ユーザーが所属するグループ（ロール）をインポートする を参照してください。

URL

https://sample.cybozu.com/v1/user/groups.json

HTTP メソッド

PUT

必要なアクセス権

リクエスト

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

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

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

ボディ
1
2
3
4

{
  "code": "sato-noboru",
  "groups": ["recruit2022", "recruit2023"]
}

レスポンス

1

{}

サンプルコード

curl を使ったリクエスト
1
2
3
4
5
6
7

curl -X PUT 'https://sample.cybozu.com/v1/user/groups.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "code": "sato-noboru",
        "groups": ["recruit2022", "recruit2023"]
      }'

制限事項

  • cybozu.com 共通管理における次の操作と、API の実行を並行して行うことは推奨しません。
    • 組織とユーザーの設定画面における、ユーザーに対する各操作
    • ファイルからの読み込み