Update SMS configuration

This endpoint has been deprecated. To complete this action, use the Update phone configuration endpoint instead.

Previous functionality: Update the multi-factor authentication SMS provider configuration in your tenant.

PUT https://{tenantDomain}/api/v2/guardian/factors/sms/selected-provider

C#

C#

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

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.Sms.SetProviderAsync(
            new SetGuardianFactorsProviderSmsRequestContent {
                Provider = GuardianFactorsProviderSmsProviderEnum.Auth0
            }
        );
    }

}

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.SetGuardianFactorsProviderSmsRequestContent{
        Provider: management.GuardianFactorsProviderSmsProviderEnumAuth0,
    }
    mgmt.Guardian.Factors.Sms.SetProvider(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.guardian.factors.types.SetGuardianFactorsProviderSmsRequestContent;
import com.auth0.client.mgmt.types.GuardianFactorsProviderSmsProviderEnum;

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

        client.guardian().factors().sms().setProvider(
            SetGuardianFactorsProviderSmsRequestContent
                .builder()
                .provider(GuardianFactorsProviderSmsProviderEnum.AUTH_0)
                .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\Sms\Requests\SetGuardianFactorsProviderSmsRequestContent;
use Auth0\SDK\API\Management\Types\GuardianFactorsProviderSmsProviderEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->guardian->factors->sms->setProvider(
    new SetGuardianFactorsProviderSmsRequestContent([
        'provider' => GuardianFactorsProviderSmsProviderEnum::Auth0->value,
    ]),
);

from auth0.management import ManagementClient

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

client.guardian.factors.sms.set_provider(
    provider="auth0",
)

require "auth0"

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

client.guardian.factors.sms.set_provider(provider: "auth0")

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.factors.sms.setProvider({
        provider: "auth0",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.factors.sms.setProvider({
        provider: "auth0",
    });
}
main();

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

200

{}

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

provider · enum<string> · required

Available options: auth0, twilio, phone-message-hook

Response

200

application/json

Returns selected SMS provider configuration

provider · enum<string>

Available options: auth0, twilio, phone-message-hook