ディレクトリの削除
DELETE /v1/directories/{directory_id} · 権限 directories:write
ディレクトリを即時かつ完全に削除します。トークン(以後、IDプロバイダーのSCIMリクエストは 401 を受け取ります)、デプロビジョニング保留、グループ、グループのメンバーシップ、ディレクトリのユーザーレコードが、同じトランザクションで削除されます。削除は directory.deleted として監査されます。すでに削除されたディレクトリを削除しようとすると 404 を返します。
リクエスト
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
directory_id |
path | はい | SCIMディレクトリID(dir_…)。 |
リクエストボディはありません。
レスポンス
204 No Content。
エラー
| HTTP | code | 発生条件 |
|---|---|---|
| 404 | not_found |
ディレクトリがこの環境に存在しません。 |
| 401 | unauthenticated |
認証情報がない、無効、または失効しています。 |
| 403 | insufficient_permissions |
認証情報に必要な権限がありません。 |
| 429 | rate_limited |
レート制限を超えました。Retry-After の期間を待ってから再試行してください。 |
| 503 | service_unavailable |
ディレクトリ同期が一時的に利用できないか、このデプロイメントで構成されていません。Retry-After の期間を待ってから再試行してください。 |
例
curl -i -X DELETE "https://api.eu.keenauth.com/v1/directories/dir_01j9xm2n4p6q8r0s2t4v6w8y0z" \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY"