メインコンテンツへスキップ
GET
/
email-templates
/
{templateName}
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.emailTemplates.get("verify_email");
}
main();
{
  "template": "verify_email",
  "body": "<string>",
  "from": "sender@auth0.com",
  "resultUrl": "<string>",
  "subject": "<string>",
  "syntax": "liquid",
  "urlLifetimeInSeconds": 1,
  "includeEmailInRedirect": true,
  "enabled": true
}

承認

​
Authorization
string
header
必須

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

パスパラメータ

​
templateName
enum<string>
デフォルト:verify_email
必須

Template name. Can be 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 (legacy), or password_reset (legacy).

利用可能なオプション:
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

レスポンス

Template successfully retrieved.

​
template
enum<string>
デフォルト:verify_email

Template name. Can be 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 (legacy), or password_reset (legacy).

利用可能なオプション:
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
​
body
string | null

Body of the email template.

​
from
string | null
デフォルト:sender@auth0.com

Senders from email address.

​
resultUrl
string | null

URL to redirect the user to after a successful action.

​
subject
string | null

Subject line of the email.

​
syntax
string | null
デフォルト:liquid

Syntax of the template body.

​
urlLifetimeInSeconds
number | null

Lifetime in seconds that the link within the email will be valid for.

必須範囲: x >= 0
​
includeEmailInRedirect
boolean

Whether the reset_email and verify_email templates should include the user's email address as the email parameter in the returnUrl (true) or whether no email address should be included in the redirect (false). Defaults to true.

​
enabled
boolean | null

Whether the template is enabled (true) or disabled (false).