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

目次

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

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

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

URL

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

HTTPメソッド

PUT

必要なアクセス権

cybozu.com共通管理者 (External link)

リクエスト

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

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

ボディ
1
2
3
4
{
  "code": "Recruit2022",
  "users": ["sato-noboru", "kato-misaki"]
}

レスポンス

1
{}

サンプルコード

curlを使ったリクエスト
1
2
3
4
5
6
7
curl -X PUT 'https://sample.cybozu.com/v1/group/users.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "code": "Recruit2022",
        "users": ["sato-noboru", "kato-misaki"]
      }'
制限事項
  • 動的グループの所属ユーザーは更新できません。
    所属ユーザーを変更するには、動的グループの条件を編集してください。
    動的グループの条件を指定する (External link)
  • cybozu.com共通管理における次の操作と、APIの実行を並行して行うことは推奨しません。
    • グループの設定画面における、グループに対する各操作
    • ファイルからの読み込み