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 | 対象が Admin Identity です。 |