Forward Identity を削除します。
DELETE /api/v1/forward/identities/{identity_id}
削除後、この Identity を使用して Session を作成したり、有効な Identity を必要とする操作を実行したりすることはできません。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | Yes | Forward Identity ID。 |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
id | string | 削除された Identity ID。 |
deleted | boolean | 削除が完了したかどうか。成功時は true。 |
Errors
| HTTP | Type | Code | 発生条件 |
|---|---|---|---|
| 401 | authentication_error | authentication_required | PAT または SAT が無効または期限切れです。 |
| 404 | not_found_error | - | Identity が存在しないか、呼び出し元から参照できません。 |
| 409 | conflict_error | - | 現在の状態では Identity を削除できません。 |
Notes
- 削除された Identity は新しい Session の作成に使用できません。
- 既存の Session、イベント、監査レコードはこの操作の影響を受けません。