コネクションを削除
DELETE /v1/connections/{connection_id} · 権限 connections:write
コネクションを削除します。ユーザーデータは削除されません。If-Match が必須です。ユーザーがアクティブなコネクションからアイデンティティを持っている場合、削除は connection_in_use で失敗します。最初にコネクションを無効化してください。コネクションはアプリケーションコネクションリストからも削除されます。 削除したコネクションは、30日以内であれば :restore で inactive として復元できます。その後は完全に削除されます。
リクエスト
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
connection_id |
string | はい | コネクション識別子 (conn_…)。 |
If-Match |
header | はい | 最後に読み取られたコネクションの ETag。存在しない場合: 428。無効な場合: 412。 |
レスポンス
204 No Content、ボディなし。
エラー
| HTTP | コード | 概要 |
|---|---|---|
| 404 | not_found |
コネクションが存在しないか、別の環境に属しています。 |
| 409 | connection_in_use |
ユーザーがこのアクティブなコネクションからアイデンティティを持っています。最初に無効化してください。 |
| 412 | precondition_failed |
If-Match が現在のバージョンと一致しません。 |
| 428 | precondition_required |
If-Match ヘッダーがありません。 |
| 401 | unauthenticated |
認証情報が見つからない、無効、または取り消されています。 |
| 403 | insufficient_permissions |
認証情報に必要な権限がありません。 |
| 429 | rate_limited |
レート制限を超えました。Retry-After 期間後に再試行してください。 |
| 503 | service_unavailable |
依存関係が一時的に利用できません。Retry-After 期間後に再試行してください。 |
例
curl -X DELETE https://api.eu.keenauth.com/v1/connections/conn_0k3v8m1q2x9dz4h7s5t6w0y1ab \
-H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
-H 'If-Match: "2"'