メールテンプレートを作成

メールテンプレートを作成します。

POST https://{tenantDomain}/api/v2/email-templates

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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>",
        ),
    )
    request := &management.CreateEmailTemplateRequestContent{
        Template: management.EmailTemplateNameEnumVerifyEmail,
    }
    client.EmailTemplates.Create(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.emailTemplates.create({
        template: "verify_email",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.emailTemplates.create({
        template: "verify_email",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/email-templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "<string>",
  "enabled": true,
  "from": "[e-mail]",
  "subject": "<string>",
  "syntax": "liquid",
  "template": "verify_email",
  "includeEmailInRedirect": true,
  "resultUrl": "<string>",
  "urlLifetimeInSeconds": 1
}
'

import requests

url = "https://{tenantDomain}/api/v2/email-templates"

payload = {
    "body": "<string>",
    "enabled": True,
    "from": "[e-mail]",
    "subject": "<string>",
    "syntax": "liquid",
    "template": "verify_email",
    "includeEmailInRedirect": True,
    "resultUrl": "<string>",
    "urlLifetimeInSeconds": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/email-templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'body' => '<string>',
    'enabled' => true,
    'from' => '[e-mail]',
    'subject' => '<string>',
    'syntax' => 'liquid',
    'template' => 'verify_email',
    'includeEmailInRedirect' => true,
    'resultUrl' => '<string>',
    'urlLifetimeInSeconds' => 1
  ]),
  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.post("https://{tenantDomain}/api/v2/email-templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"body\": \"<string>\",\n  \"enabled\": true,\n  \"from\": \"[e-mail]\",\n  \"subject\": \"<string>\",\n  \"syntax\": \"liquid\",\n  \"template\": \"verify_email\",\n  \"includeEmailInRedirect\": true,\n  \"resultUrl\": \"<string>\",\n  \"urlLifetimeInSeconds\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/email-templates")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"body\": \"<string>\",\n  \"enabled\": true,\n  \"from\": \"[e-mail]\",\n  \"subject\": \"<string>\",\n  \"syntax\": \"liquid\",\n  \"template\": \"verify_email\",\n  \"includeEmailInRedirect\": true,\n  \"resultUrl\": \"<string>\",\n  \"urlLifetimeInSeconds\": 1\n}"

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

200

{
  "body": "<string>",
  "enabled": true,
  "from": "[e-mail]",
  "subject": "<string>",
  "syntax": "liquid",
  "template": "verify_email",
  "includeEmailInRedirect": true,
  "resultUrl": "<string>",
  "urlLifetimeInSeconds": 1
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

body · string | null · 必須

メールテンプレートの本文。

enabled · boolean | null · 必須

テンプレートが有効か（true）、無効か（false）。

from · string | null · デフォルト: [e-mail] · 必須

送信元の from メールアドレス。

subject · string | null · 必須

メールの件名。

syntax · string | null · デフォルト: liquid · 必須

テンプレート本文の構文。

template · enum<string> · デフォルト: verify_email · 必須

テンプレート名。verify_email、verify_email_by_code、reset_email、reset_email_by_code、welcome_email、blocked_account、stolen_credentials、enrollment_email、mfa_oob_code、user_invitation、async_approval、change_password（レガシー）、または password_reset（レガシー）を指定できます。

利用可能なオプション: verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, change_password, password_reset, async_approval

includeEmailInRedirect · boolean

reset_email および verify_email テンプレートで、returnUrl の email パラメーターにユーザーのメールアドレスを含めるか（true）、リダイレクト時にメールアドレスを含めないか（false）を指定します。既定値は true です。

resultUrl · string | null

アクションの完了後にユーザーをリダイレクトする URL。

urlLifetimeInSeconds · number | null

メール内のリンクの有効期間（秒）。

必須範囲: x >= 0

レスポンス

200

application/json

テンプレートが正常に作成されました。

body · string | null · 必須

メールテンプレートの本文。

enabled · boolean | null · 必須

テンプレートが有効か（true）、無効か（false）。

from · string | null · デフォルト: [e-mail] · 必須

送信者の from メールアドレス。

subject · string | null · 必須

メールの件名。

syntax · string | null · デフォルト: liquid · 必須

テンプレート本文の構文。

template · enum<string> · デフォルト: verify_email · 必須

テンプレート名。verify_email、verify_email_by_code、reset_email、reset_email_by_code、welcome_email、blocked_account、stolen_credentials、enrollment_email、mfa_oob_code、user_invitation、async_approval、change_password（レガシー）、または password_reset（レガシー）を指定できます。

利用可能なオプション: verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, change_password, password_reset, async_approval

includeEmailInRedirect · boolean

reset_email および verify_email テンプレートで、returnUrl の email パラメーターにユーザーのメールアドレスを含めるか（true）、リダイレクト時にメールアドレスを含めないか（false）を指定します。既定値は true です。

resultUrl · string | null

操作が成功した後にユーザーをリダイレクトする URL。

urlLifetimeInSeconds · number | null

メール内のリンクの有効期間（秒）。

必須範囲: x >= 0