Get the email template list

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.

Get the email template list

Method name

ManagementClient.getEmailTemplates

Request parameters

Name	Type	Required	Default value	Description	Sample value

Sample code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If you are a privately deployed customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.getEmailTemplates();

  console.log(JSON.stringify(result, null, 2));
})();

Request response

Type: GetEmailTemplatesRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful, 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful request is not returned). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a GetEmailTemplatesDataDto	Response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "templates": {
      "customizeEnabled": true,
      "type": "WELCOME_EMAIL",
      "name": "Welcome email",
      "subject": "Welcome to {{app_name}}",
      "sender": "{{client_name}}",
      "content": "xxx",
      "expiresIn": 300,
      "redirectTo": "https://example.com",
      "tplEngine": "handlebar"
    },
    "categories": {
      "title": "Notification Template",
      "titleEn": "Notification Template",
      "desc": "Support the content of the Welcome Email and First-Created Account Notification",
      "descEn": "We support the content of the Welcome Email and First-Created Account Notification"
    }
  }
}

Data Structure

GetEmailTemplatesDataDto

Name	Type	Is it required	Description	Sample value
templates	array	Yes	Template list Nested type: <a EmailTemplateDto.
categories	array	yes	template type list nested type: <a EmailTemplateCategoryDto.

EmailTemplateDto

Name	Type	Is it required?	Description	Example value
customizeEnabled	boolean	yes	Whether to enable custom templates	true
type	string	yes	Template type: - WELCOME_EMAIL: Welcome email - FIRST_CREATED_USER: First created user notification - REGISTER_VERIFY_CODE: Registration verification code - LOGIN_VERIFY_CODE: Login verification code - MFA_VERIFY_CODE: MFA verification code - INFORMATION_COMPLETION_VERIFY_CODE: Registration information completion verification code - FIRST_EMAIL_LOGIN_VERIFY : First email login verification - CONSOLE_CONDUCTED_VERIFY: Initiate email verification in the console - USER_PASSWORD_UPDATE_REMIND: User expiration reminder - ADMIN_RESET_USER_PASSWORD_NOTIFICATION: Administrator successfully reset user password notification - USER_PASSWORD_RESET_NOTIFICATION: Notification of successful user password reset - RESET_PASSWORD_VERIFY_CODE: Reset password verification code - SELF_UNLOCKING_VERIFY_CODE: Self-service unlocking verification code - EMAIL_BIND_VERIFY_CODE: Binding email verification code - EMAIL_UNBIND_VERIFY_CODE: Unbinding email verification code	WELCOME_EMAIL
name	string	yes	Email template name	Welcome email
subject	string	yes	Email subject	Welcome to {{app_name}}
sender	string	yes	Email sender name	{{client_name}}
content	string	yes	Email content template	xxx
expiresIn	number	no	Verification code/email validity period. Only verification emails have validity period.	300
redirectTo	string	no	The address to jump to after completing email verification. Only valid for FIRST_EMAIL_LOGIN_VERIFY and CONSOLE_CONDUCTED_VERIFY type templates.	https://example.com
tplEngine	string	no	Template rendering engine. GenAuth email template currently supports two rendering engines: - handlebar: For detailed usage, please see: handlebars official documentation - ejs: For detailed usage, please see: ejs official documentation By default, handlerbar will be used as the template rendering engine.	handlebar

EmailTemplateCategoryDto

Name	Type	Is it required?	Description	Sample value
title	string	Yes	Category name	Notification template
titleEn	string	Yes	Category English name	Notification Template
desc	string	yes	description	We support the content of the Welcome Email and First-Created Account Notification
descEn	string	yes	English description	We support the content of the Welcome Email and First-Created Account Notification