删除一个 Forward Identity。
DELETE /api/v1/forward/identities/{identity_id}
删除后,该 Identity 不能继续用于创建 Session 或其他需要有效 Identity 的操作。
请求头
| Header | 是否必填 | 说明 |
|---|---|---|
| Authorization | 是 | Bearer <PAT 或 SAT> |
路径参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| identity_id | string | 是 | Forward Identity ID。 |
示例请求
示例响应
HTTP 200 OK
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 被删除的 Identity ID。 |
| deleted | boolean | 是否已完成删除。成功响应为 true。 |
错误
| HTTP | Type | Code | 触发条件 |
|---|---|---|---|
| 404 | not_found_error | - | Identity 不存在或当前调用方不可见。 |
| 409 | conflict_error | - | 当前状态不允许删除。 |
| 401 | authentication_error | authentication_required | PAT 或 SAT 无效或已过期。 |
备注
- 删除后的 Identity 不允许继续创建 Session。
- 已产生的历史 Session、事件和审计记录不受该操作影响。