auth0.EmailTemplate does not work for the change_password template type

[1tmb]

What happened?

1. Followed https://www.pulumi.com/registry/packages/auth0/api-docs/emailtemplate/#auth0-emailtemplate
2. Pulumi plan suggests a chance which looks correct
3. Pulumi update uploads resource and says that the upload has been successful

Expected: template updated in Auth0
Actual: template unchanged in Auth0

Example

import { Input, Resource } from "@pulumi/pulumi";
import * as fs from "fs";
import path = require("path");

function getHtmlTemplateAsString(path: string): string {
  try {
    const html = fs.readFileSync(path, "utf8");
    return html;
  } catch (err) {
    console.error("Error reading file:", err);
    return "";
  }
}

export function getChangePasswordEmailTemplate(
  supportEmailAddress: string,
  emailProvider: Input<Resource>
) {
  const templateLocation = path.resolve(
    __dirname,
    "./templates/change-password.html"
  );
  const html = getHtmlTemplateAsString(templateLocation);
  return new auth0.EmailTemplate(
    "changePasswordEmailTemplate",
    {
      body: html,
      from: supportEmailAddress,
      enabled: true,
      subject: "Reset your password",
      syntax: "liquid",
      template: "change_password",
      urlLifetimeInSeconds: 3600,
    },
    {
      dependsOn: [emailProvider],
    }
  );
}

const apiKey = "myApiKey"
const supportEmailAddress = "[email protected]"
export const emailProvider = configureEmailProvider(apiKey, supportEmailAddress);
export const passwordResetEmailTemplate = getChangePasswordEmailTemplate(supportEmailAddress, emailProvider);

Output of pulumi about

CLI
Version 3.86.0
Go Version go1.21.1
Go Compiler gc

Plugins
NAME VERSION
auth0 2.24.3
nodejs unknown

Host
OS fedora
Version 38
Arch x86_64

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

[1tmb]

Closing as not an issue. After digging into the issue in lieu of documentation (sigh), I have learned that this is caused by configuration. This is solved as follows:

 return new auth0.EmailTemplate(
    "reset_email",
    {
      body: html,
      from: supportEmailAddress,
      enabled: true,
      subject: "Reset your password",
      syntax: "liquid",
      template: "reset_email",
      urlLifetimeInSeconds: 3600,
    },
    {
      dependsOn: [emailProvider],
    }
  );

The changes are as follows:

1. change_password is apparently deprecated in favour of reset_email
2. To resolve the less than helpful error message "the template property provided in payload must match the template in the URL" you need to ensure that the name argument is the same string value as the template argument.