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,
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        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
}
'

import requests

url = "https://{tenantDomain}/api/v2/guardian/factors/{name}"

payload = { "enabled": True }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/guardian/factors/{name}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.put("https://{tenantDomain}/api/v2/guardian/factors/{name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/guardian/factors/{name}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enabled\": true\n}"

response = http.request(request)
puts response.read_body

200

{
  "enabled": true
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

name · enum<string> · デフォルト: sms · 必須

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

利用可能なオプション: push-notification, sms, email, duo, otp, webauthn-roaming, webauthn-platform, recovery-code

Minimum string length: 1

ボディ

application/jsonapplication/x-www-form-urlencoded

enabled · boolean · 必須

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

レスポンス

200

application/json

Factor updated successfully.

enabled · boolean · 必須

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