Get SMS enrollment and verification templates

This endpoint has been deprecated. To complete this action, use the Retrieve enrollment and verification phone templates endpoint instead.

Previous function: Retrieve details of SMS enrollment and verification templates configured for your tenant.

GET https://{tenantDomain}/api/v2/guardian/factors/sms/templates

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.Guardian.Factors.Sms.GetTemplates(
        context.TODO(),
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request GET \
  --url https://{tenantDomain}/api/v2/guardian/factors/sms/templates \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/guardian/factors/sms/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/guardian/factors/sms/templates")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "enrollment_message": "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
  "verification_message": "{{code}} is your verification code for {{tenant.friendly_name}}"
}

{
  "enrollment_message": "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
  "verification_message": "{{code}} is your verification code for {{tenant.friendly_name}}"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Réponse

200

application/json

SMS enrollment and verification templates successfully retrieved.

enrollment_message · string · défaut: {{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment. · requis

Message sent to the user when they are invited to enroll with a phone number.

verification_message · string · défaut: {{code}} is your verification code for {{tenant.friendly_name}} · requis

Message sent to the user when they are prompted to verify their account.