Skip to main content
Identities

Identity を無効にする

Forward Identity を無効にします。

POST /api/v1/forward/identities/{identity_id}/disable

リクエストヘッダー

Header必須説明
AuthorizationはいBearer <PAT または SAT>

パスパラメーター

パラメーター必須説明
identity_idstringはいForward Identity ID。

レスポンス例

HTTP 200 OK
{
  "id": "idn_019eabc123",
  "enabled": false
}

レスポンスフィールド

フィールド説明
idstringIdentity ID。
enabledboolean無効化後の状態。常に false

エラー

HTTPTypeCode発生条件
401authentication_errorauthentication_requiredPAT または SAT が無効、期限切れ、または指定されていません。
404not_found_error-Identity が存在しないか、呼び出し元から参照できません。
409conflict_errorADMIN_IDENTITY_READ_ONLY対象が Admin Identity です。

注意事項

無効化後は、有効な Identity を必要とする操作を実行できません。
ベストプラクティス