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

グループを削除する

目次

グループを削除する

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

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

URL

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

HTTP メソッド

DELETE

必要なアクセス権

リクエスト

パラメーター
パラメーター名 型 必須 説明
codes 文字列 必須 グループコード
前後の空白は取り除かれません。
リクエストの例
ヘッダー
1
2
3
4

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

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

ボディ
1
2
3

{
  "codes": ["group1", "group2"]
}

レスポンス

1

{}

制限事項

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