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

グループを登録する

目次

グループを登録する

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

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

URL

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

HTTP メソッド

POST

必要なアクセス権

リクエスト

パラメーター
パラメーター名 型 必須 説明
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
11
12
13
14
15
16

{
  "groups": [
    {
      "code": "group1",
      "name": "group1",
      "type": "static",
      "description": "test group"
    },
    {
      "code": "group2",
      "name": "group2",
      "type": "dynamic",
      "description": ""
    }
  ]
}

レスポンス

1

{}

制限事項

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