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

組織を削除する

目次

組織を削除する

組織を削除します。
1 度に削除できる組織は、100 件までです。

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

URL

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

HTTP メソッド

DELETE

必要なアクセス権

リクエスト

パラメーター
パラメーター名 型 必須 説明
codes 文字列 必須 組織コード
親組織を削除すると、子組織も削除されます。
組織を削除する場合の注意事項 (External link)
リクエストの例
ヘッダー
1
2
3
4

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

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

ボディ
1
2
3

{
  "codes": ["Sales01", "Sales02"]
}

レスポンス

1

{}

サンプルコード

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

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

制限事項

  • 組織の事前設定 (External link) で予約データが作成されている場合は、API を実行できません。
  • cybozu.com 共通管理における次の操作と、API の実行を並行して行うことは推奨しません。
    • 組織とユーザーの設定画面における、組織に対する各操作
    • ファイルからの読み込み