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": ["Recruit2013"]
}

サンプルコード

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

curl を使ったリクエスト
1
2
3
4
5
6

curl -X DELETE 'https://sample.cybozu.com/v1/groups.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "codes": ["Recruit2013"]
      }'

レスポンス

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

1

{}

制限事項

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

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