NEnetxms
Two-Factor Authentication

Update 2FA method

Changed on

Update an existing two-factor authentication method. Only the fields provided in the request body will be modified. Requires MANAGE_2FA_METHODS access right.

put/v1/2fa/methods/{method-name}

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/2fa/methods/{method-name}
  • Auth
    HTTP bearer

Path parameters

method-namestring required

2FA method name

Request body

namestring required

Method name

driverstring required

Driver name (e.g., "TOTP", "Message")

descriptionstring

Method description

configurationobject

Driver-specific configuration

Response

2FA method updated successfully

namestring

Method name (unique identifier)

driverstring

Driver name (e.g., "TOTP", "Message")

descriptionstring

Method description

isValidboolean

Whether the method configuration is valid

configurationobject

Driver-specific configuration (structure depends on the driver)

Changes