Update Multi-Factor Method

This API updates the display name of a single configured multi-factor method for a User.

This operation only updates the method display name. It does not modify the MFA method type or delivery configuration.

Request#

Update a single multi-factor method by User Id

PUT/api/user/two-factor/{userId}?methodId={methodId}

OpenAPI Spec

Available since 1.68.0

Request Headers#

X-FusionAuth-TenantIdStringoptional

The unique Id of the tenant used to scope this API request.

The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required.

Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.

See Making an API request using a Tenant Id for additional information.

Request Parameters#

userIdUUIDrequired

The Id of the User for whom to update Multi-Factor authentication.

methodIdStringrequired

The Id of the multi-factor method to update.

Request Body#

nameStringoptional

The display name for the configured multi-factor method.

The maximum length is 256 characters.

If omitted, the method name will be cleared.

Example Request JSON

{
  "name": "Work phone"
}

Response#

Response Codes

Code	Description
200	The request was successful. The response will be empty.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The User does not exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.