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

グループを更新する

目次

グループを更新する

グループを更新します。
1 度に更新できるグループは、100 件までです。

CSV ファイルをインポートする API の詳細は、 グループ情報をインポートする を参照してください。

URL

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

HTTP メソッド

PUT

必要なアクセス権

リクエスト

パラメーター
パラメーター名 型 必須 説明
groups 配列 必須 グループ情報の一覧
groups[].code 文字列 必須 グループコード
128 文字以下で指定します。
空文字または空白文字のみは指定できません。
groups[].name 文字列 必須 グループ名
128 文字以下で指定します。
空文字または空白文字のみ、または Garoon の予約語は指定できません。
省略または null を指定すると、値は更新されません。
groups[].description 文字列 省略可 説明
1,000 文字以下で指定します。
省略または null を指定すると、値は更新されません。
リクエストの例
ヘッダー
1
2
3
4

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

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

ボディ
1
2
3
4
5
6
7
8
9

{
  "groups": [
    {
      "code": "Recruit2023",
      "name": "2023年度採用プロジェクト",
      "description": "2023年度採用プロジェクト"
    }
  ]
}

レスポンス

1

{}

サンプルコード

curl を使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

curl -X PUT 'https://sample.cybozu.com/v1/groups.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "groups": [
          {
            "code": "Recruit2023",
            "name": "2023年度新卒採用プロジェクト",
            "description": "2023年度採用プロジェクト"
          }
        ]
      }'

制限事項

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