Obtener plantillas de correo electrónico por nombre de la plantilla

Recupere una plantilla de correo electrónico por nombre predefinido. Estos nombres son 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 y async_approval. Los nombres change_password y password_reset también se admiten para escenarios heredados.

GET https://{tenantDomain}/api/v2/email-templates/{templateName}

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>",
        ),
    )
    client.EmailTemplates.Get(
        context.TODO(),
        management.EmailTemplateNameEnumVerifyEmail.Ptr(),
    )
}

200

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

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de ruta

templateName · enum<string> · predeterminado: verify_email · requerido

Nombre de la plantilla. Puede ser 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 (legado) o password_reset (legado).

Opciones disponibles: 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

Respuesta

200

application/json

Plantilla recuperada correctamente.

body · string | null

Cuerpo de la plantilla de correo electrónico.

enabled · boolean | null

Indica si la plantilla está habilitada (true) o deshabilitada (false).

from · string | null · predeterminado: [e-mail]

Dirección de correo electrónico from del remitente.

includeEmailInRedirect · boolean

Indica si las plantillas reset_email y verify_email deben incluir la dirección de correo electrónico del usuario como parámetro email en la returnUrl (true) o si no debe incluirse ninguna dirección de correo electrónico en la redirección (false). El valor predeterminado es true.

resultUrl · string | null

URL a la que se redirigirá al usuario después de que la acción se complete correctamente.

subject · string | null

Asunto del correo electrónico.

syntax · string | null · predeterminado: liquid

Sintaxis del cuerpo de la plantilla.

template · enum<string> · predeterminado: verify_email

Nombre de la plantilla. Puede ser 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 (legado) o password_reset (legado).

Opciones disponibles: 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

urlLifetimeInSeconds · number | null

Duración en segundos durante la que el enlace incluido en el correo electrónico será válido.

Rango requerido: x >= 0