Update the Enabled Phone Factors

Replace the list of phone-type MFA factors (i.e., sms and voice) that are enabled for your tenant.

PUT https://{tenantDomain}/api/v2/guardian/factors/phone/message-types

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Guardian.Factors;
using System.Collections.Generic;

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.Phone.SetMessageTypesAsync(
            new SetGuardianFactorPhoneMessageTypesRequestContent {
                MessageTypes = new List<GuardianFactorPhoneFactorMessageTypeEnum>(){
                    GuardianFactorPhoneFactorMessageTypeEnum.Sms,
                }

            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v2/management"
    client "github.com/auth0/go-auth0/v2/management/client"
    factors "github.com/auth0/go-auth0/v2/management/guardian/factors"
    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 := &factors.SetGuardianFactorPhoneMessageTypesRequestContent{
        MessageTypes: []management.GuardianFactorPhoneFactorMessageTypeEnum{
            management.GuardianFactorPhoneFactorMessageTypeEnumSms,
        },
    }
    mgmt.Guardian.Factors.Phone.SetMessageTypes(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.guardian.factors.types.SetGuardianFactorPhoneMessageTypesRequestContent;
import com.auth0.client.mgmt.types.GuardianFactorPhoneFactorMessageTypeEnum;
import java.util.Arrays;

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

        client.guardian().factors().phone().setMessageTypes(
            SetGuardianFactorPhoneMessageTypesRequestContent
                .builder()
                .messageTypes(
                    Arrays.asList(GuardianFactorPhoneFactorMessageTypeEnum.SMS)
                )
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Guardian\Factors\Phone\Requests\SetGuardianFactorPhoneMessageTypesRequestContent;
use Auth0\SDK\API\Management\Types\GuardianFactorPhoneFactorMessageTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->guardian->factors->phone->setMessageTypes(
    new SetGuardianFactorPhoneMessageTypesRequestContent([
        'messageTypes' => [
            GuardianFactorPhoneFactorMessageTypeEnum::Sms->value,
        ],
    ]),
);

from auth0.management import ManagementClient

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

client.guardian.factors.phone.set_message_types(
    message_types=[
        "sms"
    ],
)

require "auth0"

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

client.guardian.factors.phone.set_message_types(message_types: ["sms"])

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.factors.phone.setMessageTypes({
        messageTypes: [
            "sms",
        ],
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.factors.phone.setMessageTypes({
        messageTypes: [
            "sms",
        ],
    });
}
main();

curl --request PUT \
  --url https://{tenantDomain}/api/v2/guardian/factors/phone/message-types \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "message_types": []
}
'

200

{
  "message_types": []
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Body

application/jsonapplication/x-www-form-urlencoded

message_types · enum<string>[] · required

The list of phone factors to enable on the tenant. Can include sms and voice.

Available options: sms, voice

Response

200

application/json

Returns selected SMS provider configuration

message_types · enum<string>[]

The list of phone factors to enable on the tenant. Can include sms and voice.

Available options: sms, voice