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

グループを追加する

目次

グループを追加する

固定リンクがコピーされました

グループを追加します。
一度に追加できるグループは、100件までです。

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

URL

固定リンクがコピーされました

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

HTTPメソッド

固定リンクがコピーされました

POST

必要なアクセス権

固定リンクがコピーされました

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

リクエスト

固定リンクがコピーされました

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

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

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

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

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

レスポンス

固定リンクがコピーされました

1

{}

サンプルコード

固定リンクがコピーされました

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

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

制限事項

固定リンクがコピーされました

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