停用一个 Forward Identity。
POST /api/v1/forward/identities/{identity_id}/disable
请求头
| Header | 是否必填 | 说明 |
|---|---|---|
| Authorization | 是 | Bearer <PAT 或 SAT> |
路径参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| identity_id | string | 是 | Forward Identity ID。 |
示例响应
HTTP 200 OK
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | Identity ID。 |
| enabled | boolean | 停用后的状态，固定为 false。 |
错误
| HTTP | Type | Code | 触发条件 |
|---|---|---|---|
| 401 | authentication_error | authentication_required | PAT 或 SAT 无效、已过期或缺失。 |
| 404 | not_found_error | - | Identity 不存在或当前调用方不可见。 |
| 409 | conflict_error | ADMIN_IDENTITY_READ_ONLY | 目标为管理员 Identity。 |