Update multi-factor authentication type

Update the status (i.e., enabled or disabled) of a specific multi-factor authentication factor.

PUT https://{tenantDomain}/api/v2/guardian/factors/{name}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    guardian "github.com/auth0/go-auth0/management/management/guardian"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &guardian.SetGuardianFactorRequestContent{
        Enabled: true,
    }
    client.Guardian.Factors.Set(
        context.TODO(),
        management.GuardianFactorNameEnumPushNotification.Ptr(),
        request,
    )
}

200

{
  "enabled": true
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

name · enum<string> · default: sms · required

Factor name. Can be sms, push-notification, email, duo otp webauthn-roaming, webauthn-platform, or recovery-code.

Available options: push-notification, sms, email, duo, otp, webauthn-roaming, webauthn-platform, recovery-code

Minimum string length: 1

Body

application/jsonapplication/x-www-form-urlencoded

enabled · boolean · required

Whether this factor is enabled (true) or disabled (false).

Response

200

application/json

Factor updated successfully.

enabled · boolean · required

Whether this factor is enabled (true) or disabled (false).