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}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Guardian;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Guardian.Factors.SetAsync(
            name: GuardianFactorNameEnum.PushNotification,
            request: new SetGuardianFactorRequestContent {
                Enabled = true
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &guardian.SetGuardianFactorRequestContent{
        Enabled: true,
    }
    mgmt.Guardian.Factors.Set(
        context.TODO(),
        management.GuardianFactorNameEnumPushNotification.Ptr(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.guardian.types.SetGuardianFactorRequestContent;
import com.auth0.client.mgmt.types.GuardianFactorNameEnum;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.guardian().factors().set(
            GuardianFactorNameEnum.PUSH_NOTIFICATION,
            SetGuardianFactorRequestContent
                .builder()
                .enabled(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Types\GuardianFactorNameEnum;
use Auth0\SDK\API\Management\Guardian\Factors\Requests\SetGuardianFactorRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->guardian->factors->set(
    GuardianFactorNameEnum::PushNotification->value,
    new SetGuardianFactorRequestContent([
        'enabled' => true,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.guardian.factors.set(
    name="push-notification",
    enabled=True,
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.guardian.factors.set(
  name: "push-notification",
  enabled: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.factors.set("push-notification", {
        enabled: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.factors.set("push-notification", {
        enabled: true,
    });
}
main();

curl --request PUT \
  --url https://{tenantDomain}/api/v2/guardian/factors/{name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enabled": true
}
'

200

{
  "enabled": true
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

name · enum<string> · défaut: sms · requis

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

Options disponibles: push-notification, sms, email, duo, otp, webauthn-roaming, webauthn-platform, recovery-code

Minimum string length: 1

Corps

application/jsonapplication/x-www-form-urlencoded

enabled · boolean · requis

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

Réponse

200

application/json

Factor updated successfully.

enabled · boolean · requis

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