今後のセッションに影響する Identity の構成、エントリーポイント、関連付けられたリソースをクリアします。
POST /api/v1/forward/identities/{identity_id}/clear
クリア後も Identity 自体は保持され、新しいセッションを作成できます。新しいセッションでは、クリア前の構成、スケジュール、リソースバインディングは使用されません。過去のセッションはアーカイブ状態のまま保持されます。
リクエストヘッダー
| Header | 必須 | 説明 |
|---|---|---|
Authorization | はい | Bearer <PAT または SAT> |
Content-Type | いいえ | リクエスト本文が空でない場合は application/json を使用します。 |
パスパラメーター
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
identity_id | string | はい | Forward Identity ID。 |
リクエスト本文
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
reason | string | いいえ | クリア理由。呼び出しの意図を記録する目的でのみ使用されます。 |
リクエスト例
レスポンス例
HTTP 200 OK
レスポンスフィールド
| フィールド | 型 | 説明 |
|---|---|---|
identity_id | string | クリアされた Identity の ID。 |
status | string | クリア状態。成功時は completed。 |
completed_at | string | Forward 側でクリアが完了した時刻。RFC 3339 形式。 |
summary.identity_configs_archived | number | 処理された Identity Config の数。 |
summary.resource_bindings_archived | number | 処理されたリソースバインディングの数。 |
summary.identity_owned_resources_archived | number | 処理された Identity 所有リソースの数。 |
summary.schedules_archived | number | 処理された Schedule の数。 |
summary.schedule_runs_skipped | number | スキップされた実行待ち Schedule Run の数。 |
summary.sessions_archived | number | 処理された Session の数。 |
エラー
| HTTP | Type | Code | 発生条件 |
|---|---|---|---|
| 400 | invalid_request_error | - | リクエスト本文またはパラメーターが不正です。 |
| 401 | authentication_error | authentication_required | PAT または SAT が無効、期限切れ、または指定されていません。 |
| 404 | not_found_error | - | Identity が存在しないか、呼び出し元から参照できません。 |
| 409 | conflict_error | ADMIN_IDENTITY_READ_ONLY または - | 対象が読み取り専用の Admin Identity であるか、実行中の Schedule Run があります。 |
注意事項
- この API は Identity 自体を削除しません。
- クリア後も新しい Session、構成、Schedule を作成できます。
- 再度実行しても、処理済みのリソースや構成は復元されません。