Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Auth0 Provider
  3. API Docs
  4. EmailProvider
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

auth0.EmailProvider

Explore with Pulumi AI

auth0 logo
Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
pulumi/pulumi-auth0

    With Auth0, you can have standard welcome, password reset, and account verification email-based workflows built right into Auth0. This resource allows you to configure email providers, so you can route all emails that are part of Auth0’s authentication workflows through the supported high-volume email service of your choice.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as auth0 from "@pulumi/auth0";

// This is an example on how to set up the email provider with Amazon SES.
const amazonSesEmailProvider = new auth0.EmailProvider("amazon_ses_email_provider", {
    name: "ses",
    enabled: true,
    defaultFromAddress: "accounts@example.com",
    credentials: {
        accessKeyId: "AKIAXXXXXXXXXXXXXXXX",
        secretAccessKey: "7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        region: "us-east-1",
    },
});
// This is an example on how to set up the email provider with SMTP.
const smtpEmailProvider = new auth0.EmailProvider("smtp_email_provider", {
    name: "smtp",
    enabled: true,
    defaultFromAddress: "accounts@example.com",
    credentials: {
        smtpHost: "your.smtp.host.com",
        smtpPort: 583,
        smtpUser: "SMTP Username",
        smtpPass: "SMTP Password",
    },
});
// This is an example on how to set up the email provider with Sendgrid.
const sendgridEmailProvider = new auth0.EmailProvider("sendgrid_email_provider", {
    name: "sendgrid",
    enabled: true,
    defaultFromAddress: "accounts@example.com",
    credentials: {
        apiKey: "secretAPIKey",
    },
});
// This is an example on how to set up the email provider with Azure CS.
const azureCsEmailProvider = new auth0.EmailProvider("azure_cs_email_provider", {
    name: "azure_cs",
    enabled: true,
    defaultFromAddress: "accounts@example.com",
    credentials: {
        azureCsConnectionString: "azure_cs_connection_string",
    },
});
// This is an example on how to set up the email provider with MS365.
const ms365EmailProvider = new auth0.EmailProvider("ms365_email_provider", {
    name: "ms365",
    enabled: true,
    defaultFromAddress: "accounts@example.com",
    credentials: {
        ms365TenantId: "ms365_tenant_id",
        ms365ClientId: "ms365_client_id",
        ms365ClientSecret: "ms365_client_secret",
    },
});
// This is an example on how to set up the email provider with a custom action.
// Make sure a corresponding action exists with custom-email-provider as supported triggers
const customEmailProvider = new auth0.EmailProvider("custom_email_provider", {
    name: "custom",
    enabled: true,
    defaultFromAddress: "accounts@example.com",
    credentials: {},
});

    import pulumi
import pulumi_auth0 as auth0

# This is an example on how to set up the email provider with Amazon SES.
amazon_ses_email_provider = auth0.EmailProvider("amazon_ses_email_provider",
    name="ses",
    enabled=True,
    default_from_address="accounts@example.com",
    credentials={
        "access_key_id": "AKIAXXXXXXXXXXXXXXXX",
        "secret_access_key": "7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        "region": "us-east-1",
    })
# This is an example on how to set up the email provider with SMTP.
smtp_email_provider = auth0.EmailProvider("smtp_email_provider",
    name="smtp",
    enabled=True,
    default_from_address="accounts@example.com",
    credentials={
        "smtp_host": "your.smtp.host.com",
        "smtp_port": 583,
        "smtp_user": "SMTP Username",
        "smtp_pass": "SMTP Password",
    })
# This is an example on how to set up the email provider with Sendgrid.
sendgrid_email_provider = auth0.EmailProvider("sendgrid_email_provider",
    name="sendgrid",
    enabled=True,
    default_from_address="accounts@example.com",
    credentials={
        "api_key": "secretAPIKey",
    })
# This is an example on how to set up the email provider with Azure CS.
azure_cs_email_provider = auth0.EmailProvider("azure_cs_email_provider",
    name="azure_cs",
    enabled=True,
    default_from_address="accounts@example.com",
    credentials={
        "azure_cs_connection_string": "azure_cs_connection_string",
    })
# This is an example on how to set up the email provider with MS365.
ms365_email_provider = auth0.EmailProvider("ms365_email_provider",
    name="ms365",
    enabled=True,
    default_from_address="accounts@example.com",
    credentials={
        "ms365_tenant_id": "ms365_tenant_id",
        "ms365_client_id": "ms365_client_id",
        "ms365_client_secret": "ms365_client_secret",
    })
# This is an example on how to set up the email provider with a custom action.
# Make sure a corresponding action exists with custom-email-provider as supported triggers
custom_email_provider = auth0.EmailProvider("custom_email_provider",
    name="custom",
    enabled=True,
    default_from_address="accounts@example.com",
    credentials={})

    package main

import (
	"github.com/pulumi/pulumi-auth0/sdk/v3/go/auth0"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// This is an example on how to set up the email provider with Amazon SES.
		_, err := auth0.NewEmailProvider(ctx, "amazon_ses_email_provider", &auth0.EmailProviderArgs{
			Name:               pulumi.String("ses"),
			Enabled:            pulumi.Bool(true),
			DefaultFromAddress: pulumi.String("accounts@example.com"),
			Credentials: &auth0.EmailProviderCredentialsArgs{
				AccessKeyId:     pulumi.String("AKIAXXXXXXXXXXXXXXXX"),
				SecretAccessKey: pulumi.String("7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
				Region:          pulumi.String("us-east-1"),
			},
		})
		if err != nil {
			return err
		}
		// This is an example on how to set up the email provider with SMTP.
		_, err = auth0.NewEmailProvider(ctx, "smtp_email_provider", &auth0.EmailProviderArgs{
			Name:               pulumi.String("smtp"),
			Enabled:            pulumi.Bool(true),
			DefaultFromAddress: pulumi.String("accounts@example.com"),
			Credentials: &auth0.EmailProviderCredentialsArgs{
				SmtpHost: pulumi.String("your.smtp.host.com"),
				SmtpPort: pulumi.Int(583),
				SmtpUser: pulumi.String("SMTP Username"),
				SmtpPass: pulumi.String("SMTP Password"),
			},
		})
		if err != nil {
			return err
		}
		// This is an example on how to set up the email provider with Sendgrid.
		_, err = auth0.NewEmailProvider(ctx, "sendgrid_email_provider", &auth0.EmailProviderArgs{
			Name:               pulumi.String("sendgrid"),
			Enabled:            pulumi.Bool(true),
			DefaultFromAddress: pulumi.String("accounts@example.com"),
			Credentials: &auth0.EmailProviderCredentialsArgs{
				ApiKey: pulumi.String("secretAPIKey"),
			},
		})
		if err != nil {
			return err
		}
		// This is an example on how to set up the email provider with Azure CS.
		_, err = auth0.NewEmailProvider(ctx, "azure_cs_email_provider", &auth0.EmailProviderArgs{
			Name:               pulumi.String("azure_cs"),
			Enabled:            pulumi.Bool(true),
			DefaultFromAddress: pulumi.String("accounts@example.com"),
			Credentials: &auth0.EmailProviderCredentialsArgs{
				AzureCsConnectionString: pulumi.String("azure_cs_connection_string"),
			},
		})
		if err != nil {
			return err
		}
		// This is an example on how to set up the email provider with MS365.
		_, err = auth0.NewEmailProvider(ctx, "ms365_email_provider", &auth0.EmailProviderArgs{
			Name:               pulumi.String("ms365"),
			Enabled:            pulumi.Bool(true),
			DefaultFromAddress: pulumi.String("accounts@example.com"),
			Credentials: &auth0.EmailProviderCredentialsArgs{
				Ms365TenantId:     pulumi.String("ms365_tenant_id"),
				Ms365ClientId:     pulumi.String("ms365_client_id"),
				Ms365ClientSecret: pulumi.String("ms365_client_secret"),
			},
		})
		if err != nil {
			return err
		}
		// This is an example on how to set up the email provider with a custom action.
		// Make sure a corresponding action exists with custom-email-provider as supported triggers
		_, err = auth0.NewEmailProvider(ctx, "custom_email_provider", &auth0.EmailProviderArgs{
			Name:               pulumi.String("custom"),
			Enabled:            pulumi.Bool(true),
			DefaultFromAddress: pulumi.String("accounts@example.com"),
			Credentials:        &auth0.EmailProviderCredentialsArgs{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Auth0 = Pulumi.Auth0;

return await Deployment.RunAsync(() => 
{
    // This is an example on how to set up the email provider with Amazon SES.
    var amazonSesEmailProvider = new Auth0.EmailProvider("amazon_ses_email_provider", new()
    {
        Name = "ses",
        Enabled = true,
        DefaultFromAddress = "accounts@example.com",
        Credentials = new Auth0.Inputs.EmailProviderCredentialsArgs
        {
            AccessKeyId = "AKIAXXXXXXXXXXXXXXXX",
            SecretAccessKey = "7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
            Region = "us-east-1",
        },
    });

    // This is an example on how to set up the email provider with SMTP.
    var smtpEmailProvider = new Auth0.EmailProvider("smtp_email_provider", new()
    {
        Name = "smtp",
        Enabled = true,
        DefaultFromAddress = "accounts@example.com",
        Credentials = new Auth0.Inputs.EmailProviderCredentialsArgs
        {
            SmtpHost = "your.smtp.host.com",
            SmtpPort = 583,
            SmtpUser = "SMTP Username",
            SmtpPass = "SMTP Password",
        },
    });

    // This is an example on how to set up the email provider with Sendgrid.
    var sendgridEmailProvider = new Auth0.EmailProvider("sendgrid_email_provider", new()
    {
        Name = "sendgrid",
        Enabled = true,
        DefaultFromAddress = "accounts@example.com",
        Credentials = new Auth0.Inputs.EmailProviderCredentialsArgs
        {
            ApiKey = "secretAPIKey",
        },
    });

    // This is an example on how to set up the email provider with Azure CS.
    var azureCsEmailProvider = new Auth0.EmailProvider("azure_cs_email_provider", new()
    {
        Name = "azure_cs",
        Enabled = true,
        DefaultFromAddress = "accounts@example.com",
        Credentials = new Auth0.Inputs.EmailProviderCredentialsArgs
        {
            AzureCsConnectionString = "azure_cs_connection_string",
        },
    });

    // This is an example on how to set up the email provider with MS365.
    var ms365EmailProvider = new Auth0.EmailProvider("ms365_email_provider", new()
    {
        Name = "ms365",
        Enabled = true,
        DefaultFromAddress = "accounts@example.com",
        Credentials = new Auth0.Inputs.EmailProviderCredentialsArgs
        {
            Ms365TenantId = "ms365_tenant_id",
            Ms365ClientId = "ms365_client_id",
            Ms365ClientSecret = "ms365_client_secret",
        },
    });

    // This is an example on how to set up the email provider with a custom action.
    // Make sure a corresponding action exists with custom-email-provider as supported triggers
    var customEmailProvider = new Auth0.EmailProvider("custom_email_provider", new()
    {
        Name = "custom",
        Enabled = true,
        DefaultFromAddress = "accounts@example.com",
        Credentials = null,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.auth0.EmailProvider;
import com.pulumi.auth0.EmailProviderArgs;
import com.pulumi.auth0.inputs.EmailProviderCredentialsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // This is an example on how to set up the email provider with Amazon SES.
        var amazonSesEmailProvider = new EmailProvider("amazonSesEmailProvider", EmailProviderArgs.builder()
            .name("ses")
            .enabled(true)
            .defaultFromAddress("accounts@example.com")
            .credentials(EmailProviderCredentialsArgs.builder()
                .accessKeyId("AKIAXXXXXXXXXXXXXXXX")
                .secretAccessKey("7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
                .region("us-east-1")
                .build())
            .build());

        // This is an example on how to set up the email provider with SMTP.
        var smtpEmailProvider = new EmailProvider("smtpEmailProvider", EmailProviderArgs.builder()
            .name("smtp")
            .enabled(true)
            .defaultFromAddress("accounts@example.com")
            .credentials(EmailProviderCredentialsArgs.builder()
                .smtpHost("your.smtp.host.com")
                .smtpPort(583)
                .smtpUser("SMTP Username")
                .smtpPass("SMTP Password")
                .build())
            .build());

        // This is an example on how to set up the email provider with Sendgrid.
        var sendgridEmailProvider = new EmailProvider("sendgridEmailProvider", EmailProviderArgs.builder()
            .name("sendgrid")
            .enabled(true)
            .defaultFromAddress("accounts@example.com")
            .credentials(EmailProviderCredentialsArgs.builder()
                .apiKey("secretAPIKey")
                .build())
            .build());

        // This is an example on how to set up the email provider with Azure CS.
        var azureCsEmailProvider = new EmailProvider("azureCsEmailProvider", EmailProviderArgs.builder()
            .name("azure_cs")
            .enabled(true)
            .defaultFromAddress("accounts@example.com")
            .credentials(EmailProviderCredentialsArgs.builder()
                .azureCsConnectionString("azure_cs_connection_string")
                .build())
            .build());

        // This is an example on how to set up the email provider with MS365.
        var ms365EmailProvider = new EmailProvider("ms365EmailProvider", EmailProviderArgs.builder()
            .name("ms365")
            .enabled(true)
            .defaultFromAddress("accounts@example.com")
            .credentials(EmailProviderCredentialsArgs.builder()
                .ms365TenantId("ms365_tenant_id")
                .ms365ClientId("ms365_client_id")
                .ms365ClientSecret("ms365_client_secret")
                .build())
            .build());

        // This is an example on how to set up the email provider with a custom action.
        // Make sure a corresponding action exists with custom-email-provider as supported triggers
        var customEmailProvider = new EmailProvider("customEmailProvider", EmailProviderArgs.builder()
            .name("custom")
            .enabled(true)
            .defaultFromAddress("accounts@example.com")
            .credentials()
            .build());

    }
}

    resources:
  # This is an example on how to set up the email provider with Amazon SES.
  amazonSesEmailProvider:
    type: auth0:EmailProvider
    name: amazon_ses_email_provider
    properties:
      name: ses
      enabled: true
      defaultFromAddress: accounts@example.com
      credentials:
        accessKeyId: AKIAXXXXXXXXXXXXXXXX
        secretAccessKey: 7e8c2148xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
        region: us-east-1
  # This is an example on how to set up the email provider with SMTP.
  smtpEmailProvider:
    type: auth0:EmailProvider
    name: smtp_email_provider
    properties:
      name: smtp
      enabled: true
      defaultFromAddress: accounts@example.com
      credentials:
        smtpHost: your.smtp.host.com
        smtpPort: 583
        smtpUser: SMTP Username
        smtpPass: SMTP Password
  # This is an example on how to set up the email provider with Sendgrid.
  sendgridEmailProvider:
    type: auth0:EmailProvider
    name: sendgrid_email_provider
    properties:
      name: sendgrid
      enabled: true
      defaultFromAddress: accounts@example.com
      credentials:
        apiKey: secretAPIKey
  # This is an example on how to set up the email provider with Azure CS.
  azureCsEmailProvider:
    type: auth0:EmailProvider
    name: azure_cs_email_provider
    properties:
      name: azure_cs
      enabled: true
      defaultFromAddress: accounts@example.com
      credentials:
        azureCsConnectionString: azure_cs_connection_string
  # This is an example on how to set up the email provider with MS365.
  ms365EmailProvider:
    type: auth0:EmailProvider
    name: ms365_email_provider
    properties:
      name: ms365
      enabled: true
      defaultFromAddress: accounts@example.com
      credentials:
        ms365TenantId: ms365_tenant_id
        ms365ClientId: ms365_client_id
        ms365ClientSecret: ms365_client_secret
  # This is an example on how to set up the email provider with a custom action.
  # Make sure a corresponding action exists with custom-email-provider as supported triggers
  customEmailProvider:
    type: auth0:EmailProvider
    name: custom_email_provider
    properties:
      name: custom
      enabled: true
      defaultFromAddress: accounts@example.com
      credentials: {}

    Create EmailProvider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EmailProvider(name: string, args: EmailProviderArgs, opts?: CustomResourceOptions);
    @overload
def EmailProvider(resource_name: str,
                  args: EmailProviderArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def EmailProvider(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  credentials: Optional[EmailProviderCredentialsArgs] = None,
                  default_from_address: Optional[str] = None,
                  enabled: Optional[bool] = None,
                  name: Optional[str] = None,
                  settings: Optional[EmailProviderSettingsArgs] = None)
    func NewEmailProvider(ctx *Context, name string, args EmailProviderArgs, opts ...ResourceOption) (*EmailProvider, error)
    public EmailProvider(string name, EmailProviderArgs args, CustomResourceOptions? opts = null)
    public EmailProvider(String name, EmailProviderArgs args)
public EmailProvider(String name, EmailProviderArgs args, CustomResourceOptions options)

    type: auth0:EmailProvider
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EmailProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EmailProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EmailProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var emailProviderResource = new Auth0.EmailProvider("emailProviderResource", new()
{
    Credentials = new Auth0.Inputs.EmailProviderCredentialsArgs
    {
        AccessKeyId = "string",
        ApiKey = "string",
        AzureCsConnectionString = "string",
        Domain = "string",
        Ms365ClientId = "string",
        Ms365ClientSecret = "string",
        Ms365TenantId = "string",
        Region = "string",
        SecretAccessKey = "string",
        SmtpHost = "string",
        SmtpPass = "string",
        SmtpPort = 0,
        SmtpUser = "string",
    },
    DefaultFromAddress = "string",
    Enabled = false,
    Name = "string",
    Settings = new Auth0.Inputs.EmailProviderSettingsArgs
    {
        Headers = new Auth0.Inputs.EmailProviderSettingsHeadersArgs
        {
            XMcViewContentLink = "string",
            XSesConfigurationSet = "string",
        },
        Message = new Auth0.Inputs.EmailProviderSettingsMessageArgs
        {
            ConfigurationSetName = "string",
            ViewContentLink = false,
        },
    },
});

    example, err := auth0.NewEmailProvider(ctx, "emailProviderResource", &auth0.EmailProviderArgs{
	Credentials: &auth0.EmailProviderCredentialsArgs{
		AccessKeyId:             pulumi.String("string"),
		ApiKey:                  pulumi.String("string"),
		AzureCsConnectionString: pulumi.String("string"),
		Domain:                  pulumi.String("string"),
		Ms365ClientId:           pulumi.String("string"),
		Ms365ClientSecret:       pulumi.String("string"),
		Ms365TenantId:           pulumi.String("string"),
		Region:                  pulumi.String("string"),
		SecretAccessKey:         pulumi.String("string"),
		SmtpHost:                pulumi.String("string"),
		SmtpPass:                pulumi.String("string"),
		SmtpPort:                pulumi.Int(0),
		SmtpUser:                pulumi.String("string"),
	},
	DefaultFromAddress: pulumi.String("string"),
	Enabled:            pulumi.Bool(false),
	Name:               pulumi.String("string"),
	Settings: &auth0.EmailProviderSettingsArgs{
		Headers: &auth0.EmailProviderSettingsHeadersArgs{
			XMcViewContentLink:   pulumi.String("string"),
			XSesConfigurationSet: pulumi.String("string"),
		},
		Message: &auth0.EmailProviderSettingsMessageArgs{
			ConfigurationSetName: pulumi.String("string"),
			ViewContentLink:      pulumi.Bool(false),
		},
	},
})

    var emailProviderResource = new EmailProvider("emailProviderResource", EmailProviderArgs.builder()
    .credentials(EmailProviderCredentialsArgs.builder()
        .accessKeyId("string")
        .apiKey("string")
        .azureCsConnectionString("string")
        .domain("string")
        .ms365ClientId("string")
        .ms365ClientSecret("string")
        .ms365TenantId("string")
        .region("string")
        .secretAccessKey("string")
        .smtpHost("string")
        .smtpPass("string")
        .smtpPort(0)
        .smtpUser("string")
        .build())
    .defaultFromAddress("string")
    .enabled(false)
    .name("string")
    .settings(EmailProviderSettingsArgs.builder()
        .headers(EmailProviderSettingsHeadersArgs.builder()
            .xMcViewContentLink("string")
            .xSesConfigurationSet("string")
            .build())
        .message(EmailProviderSettingsMessageArgs.builder()
            .configurationSetName("string")
            .viewContentLink(false)
            .build())
        .build())
    .build());

    email_provider_resource = auth0.EmailProvider("emailProviderResource",
    credentials={
        "access_key_id": "string",
        "api_key": "string",
        "azure_cs_connection_string": "string",
        "domain": "string",
        "ms365_client_id": "string",
        "ms365_client_secret": "string",
        "ms365_tenant_id": "string",
        "region": "string",
        "secret_access_key": "string",
        "smtp_host": "string",
        "smtp_pass": "string",
        "smtp_port": 0,
        "smtp_user": "string",
    },
    default_from_address="string",
    enabled=False,
    name="string",
    settings={
        "headers": {
            "x_mc_view_content_link": "string",
            "x_ses_configuration_set": "string",
        },
        "message": {
            "configuration_set_name": "string",
            "view_content_link": False,
        },
    })

    const emailProviderResource = new auth0.EmailProvider("emailProviderResource", {
    credentials: {
        accessKeyId: "string",
        apiKey: "string",
        azureCsConnectionString: "string",
        domain: "string",
        ms365ClientId: "string",
        ms365ClientSecret: "string",
        ms365TenantId: "string",
        region: "string",
        secretAccessKey: "string",
        smtpHost: "string",
        smtpPass: "string",
        smtpPort: 0,
        smtpUser: "string",
    },
    defaultFromAddress: "string",
    enabled: false,
    name: "string",
    settings: {
        headers: {
            xMcViewContentLink: "string",
            xSesConfigurationSet: "string",
        },
        message: {
            configurationSetName: "string",
            viewContentLink: false,
        },
    },
});

    type: auth0:EmailProvider
properties:
    credentials:
        accessKeyId: string
        apiKey: string
        azureCsConnectionString: string
        domain: string
        ms365ClientId: string
        ms365ClientSecret: string
        ms365TenantId: string
        region: string
        secretAccessKey: string
        smtpHost: string
        smtpPass: string
        smtpPort: 0
        smtpUser: string
    defaultFromAddress: string
    enabled: false
    name: string
    settings:
        headers:
            xMcViewContentLink: string
            xSesConfigurationSet: string
        message:
            configurationSetName: string
            viewContentLink: false

    EmailProvider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EmailProvider resource accepts the following input properties:

    Credentials EmailProviderCredentials
    Configuration settings for the credentials for the email provider.
    DefaultFromAddress string
    Email address to use as the sender when no other "from" address is specified.
    Enabled bool
    Indicates whether the email provider is enabled.
    Name string
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    Settings EmailProviderSettings
    Specific email provider settings.
    Credentials EmailProviderCredentialsArgs
    Configuration settings for the credentials for the email provider.
    DefaultFromAddress string
    Email address to use as the sender when no other "from" address is specified.
    Enabled bool
    Indicates whether the email provider is enabled.
    Name string
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    Settings EmailProviderSettingsArgs
    Specific email provider settings.
    credentials EmailProviderCredentials
    Configuration settings for the credentials for the email provider.
    defaultFromAddress String
    Email address to use as the sender when no other "from" address is specified.
    enabled Boolean
    Indicates whether the email provider is enabled.
    name String
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    settings EmailProviderSettings
    Specific email provider settings.
    credentials EmailProviderCredentials
    Configuration settings for the credentials for the email provider.
    defaultFromAddress string
    Email address to use as the sender when no other "from" address is specified.
    enabled boolean
    Indicates whether the email provider is enabled.
    name string
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    settings EmailProviderSettings
    Specific email provider settings.
    credentials EmailProviderCredentialsArgs
    Configuration settings for the credentials for the email provider.
    default_from_address str
    Email address to use as the sender when no other "from" address is specified.
    enabled bool
    Indicates whether the email provider is enabled.
    name str
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    settings EmailProviderSettingsArgs
    Specific email provider settings.
    credentials Property Map
    Configuration settings for the credentials for the email provider.
    defaultFromAddress String
    Email address to use as the sender when no other "from" address is specified.
    enabled Boolean
    Indicates whether the email provider is enabled.
    name String
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    settings Property Map
    Specific email provider settings.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EmailProvider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EmailProvider Resource

    Get an existing EmailProvider resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EmailProviderState, opts?: CustomResourceOptions): EmailProvider
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        credentials: Optional[EmailProviderCredentialsArgs] = None,
        default_from_address: Optional[str] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        settings: Optional[EmailProviderSettingsArgs] = None) -> EmailProvider
    func GetEmailProvider(ctx *Context, name string, id IDInput, state *EmailProviderState, opts ...ResourceOption) (*EmailProvider, error)
    public static EmailProvider Get(string name, Input<string> id, EmailProviderState? state, CustomResourceOptions? opts = null)
    public static EmailProvider get(String name, Output<String> id, EmailProviderState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Credentials EmailProviderCredentials
    Configuration settings for the credentials for the email provider.
    DefaultFromAddress string
    Email address to use as the sender when no other "from" address is specified.
    Enabled bool
    Indicates whether the email provider is enabled.
    Name string
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    Settings EmailProviderSettings
    Specific email provider settings.
    Credentials EmailProviderCredentialsArgs
    Configuration settings for the credentials for the email provider.
    DefaultFromAddress string
    Email address to use as the sender when no other "from" address is specified.
    Enabled bool
    Indicates whether the email provider is enabled.
    Name string
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    Settings EmailProviderSettingsArgs
    Specific email provider settings.
    credentials EmailProviderCredentials
    Configuration settings for the credentials for the email provider.
    defaultFromAddress String
    Email address to use as the sender when no other "from" address is specified.
    enabled Boolean
    Indicates whether the email provider is enabled.
    name String
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    settings EmailProviderSettings
    Specific email provider settings.
    credentials EmailProviderCredentials
    Configuration settings for the credentials for the email provider.
    defaultFromAddress string
    Email address to use as the sender when no other "from" address is specified.
    enabled boolean
    Indicates whether the email provider is enabled.
    name string
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    settings EmailProviderSettings
    Specific email provider settings.
    credentials EmailProviderCredentialsArgs
    Configuration settings for the credentials for the email provider.
    default_from_address str
    Email address to use as the sender when no other "from" address is specified.
    enabled bool
    Indicates whether the email provider is enabled.
    name str
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    settings EmailProviderSettingsArgs
    Specific email provider settings.
    credentials Property Map
    Configuration settings for the credentials for the email provider.
    defaultFromAddress String
    Email address to use as the sender when no other "from" address is specified.
    enabled Boolean
    Indicates whether the email provider is enabled.
    name String
    Name of the email provider. Options include azure_cs, custom, mailgun, mandrill, ms365, sendgrid, ses, smtp and sparkpost.
    settings Property Map
    Specific email provider settings.

    Supporting Types

    EmailProviderCredentials, EmailProviderCredentialsArgs

    AccessKeyId string
    AWS Access Key ID. Used only for AWS.
    ApiKey string
    API Key for your email service. Will always be encrypted in our database.
    AzureCsConnectionString string
    Azure Communication Services Connection String.
    Domain string
    Domain name.
    Ms365ClientId string
    Microsoft 365 Client ID.
    Ms365ClientSecret string
    Microsoft 365 Client Secret.
    Ms365TenantId string
    Microsoft 365 Tenant ID.
    Region string
    Default region. Used only for AWS, Mailgun, and SparkPost.
    SecretAccessKey string
    AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
    SmtpHost string
    Hostname or IP address of your SMTP server. Used only for SMTP.
    SmtpPass string
    SMTP password. Used only for SMTP.
    SmtpPort int
    Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
    SmtpUser string
    SMTP username. Used only for SMTP.
    AccessKeyId string
    AWS Access Key ID. Used only for AWS.
    ApiKey string
    API Key for your email service. Will always be encrypted in our database.
    AzureCsConnectionString string
    Azure Communication Services Connection String.
    Domain string
    Domain name.
    Ms365ClientId string
    Microsoft 365 Client ID.
    Ms365ClientSecret string
    Microsoft 365 Client Secret.
    Ms365TenantId string
    Microsoft 365 Tenant ID.
    Region string
    Default region. Used only for AWS, Mailgun, and SparkPost.
    SecretAccessKey string
    AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
    SmtpHost string
    Hostname or IP address of your SMTP server. Used only for SMTP.
    SmtpPass string
    SMTP password. Used only for SMTP.
    SmtpPort int
    Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
    SmtpUser string
    SMTP username. Used only for SMTP.
    accessKeyId String
    AWS Access Key ID. Used only for AWS.
    apiKey String
    API Key for your email service. Will always be encrypted in our database.
    azureCsConnectionString String
    Azure Communication Services Connection String.
    domain String
    Domain name.
    ms365ClientId String
    Microsoft 365 Client ID.
    ms365ClientSecret String
    Microsoft 365 Client Secret.
    ms365TenantId String
    Microsoft 365 Tenant ID.
    region String
    Default region. Used only for AWS, Mailgun, and SparkPost.
    secretAccessKey String
    AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
    smtpHost String
    Hostname or IP address of your SMTP server. Used only for SMTP.
    smtpPass String
    SMTP password. Used only for SMTP.
    smtpPort Integer
    Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
    smtpUser String
    SMTP username. Used only for SMTP.
    accessKeyId string
    AWS Access Key ID. Used only for AWS.
    apiKey string
    API Key for your email service. Will always be encrypted in our database.
    azureCsConnectionString string
    Azure Communication Services Connection String.
    domain string
    Domain name.
    ms365ClientId string
    Microsoft 365 Client ID.
    ms365ClientSecret string
    Microsoft 365 Client Secret.
    ms365TenantId string
    Microsoft 365 Tenant ID.
    region string
    Default region. Used only for AWS, Mailgun, and SparkPost.
    secretAccessKey string
    AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
    smtpHost string
    Hostname or IP address of your SMTP server. Used only for SMTP.
    smtpPass string
    SMTP password. Used only for SMTP.
    smtpPort number
    Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
    smtpUser string
    SMTP username. Used only for SMTP.
    access_key_id str
    AWS Access Key ID. Used only for AWS.
    api_key str
    API Key for your email service. Will always be encrypted in our database.
    azure_cs_connection_string str
    Azure Communication Services Connection String.
    domain str
    Domain name.
    ms365_client_id str
    Microsoft 365 Client ID.
    ms365_client_secret str
    Microsoft 365 Client Secret.
    ms365_tenant_id str
    Microsoft 365 Tenant ID.
    region str
    Default region. Used only for AWS, Mailgun, and SparkPost.
    secret_access_key str
    AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
    smtp_host str
    Hostname or IP address of your SMTP server. Used only for SMTP.
    smtp_pass str
    SMTP password. Used only for SMTP.
    smtp_port int
    Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
    smtp_user str
    SMTP username. Used only for SMTP.
    accessKeyId String
    AWS Access Key ID. Used only for AWS.
    apiKey String
    API Key for your email service. Will always be encrypted in our database.
    azureCsConnectionString String
    Azure Communication Services Connection String.
    domain String
    Domain name.
    ms365ClientId String
    Microsoft 365 Client ID.
    ms365ClientSecret String
    Microsoft 365 Client Secret.
    ms365TenantId String
    Microsoft 365 Tenant ID.
    region String
    Default region. Used only for AWS, Mailgun, and SparkPost.
    secretAccessKey String
    AWS Secret Key. Will always be encrypted in our database. Used only for AWS.
    smtpHost String
    Hostname or IP address of your SMTP server. Used only for SMTP.
    smtpPass String
    SMTP password. Used only for SMTP.
    smtpPort Number
    Port used by your SMTP server. Please avoid using port 25 if possible because many providers have limitations on this port. Used only for SMTP.
    smtpUser String
    SMTP username. Used only for SMTP.

    EmailProviderSettings, EmailProviderSettingsArgs

    Headers EmailProviderSettingsHeaders
    Headers settings for the smtp email provider.
    Message EmailProviderSettingsMessage
    Message settings for the mandrill or ses email provider.
    Headers EmailProviderSettingsHeaders
    Headers settings for the smtp email provider.
    Message EmailProviderSettingsMessage
    Message settings for the mandrill or ses email provider.
    headers EmailProviderSettingsHeaders
    Headers settings for the smtp email provider.
    message EmailProviderSettingsMessage
    Message settings for the mandrill or ses email provider.
    headers EmailProviderSettingsHeaders
    Headers settings for the smtp email provider.
    message EmailProviderSettingsMessage
    Message settings for the mandrill or ses email provider.
    headers EmailProviderSettingsHeaders
    Headers settings for the smtp email provider.
    message EmailProviderSettingsMessage
    Message settings for the mandrill or ses email provider.
    headers Property Map
    Headers settings for the smtp email provider.
    message Property Map
    Message settings for the mandrill or ses email provider.

    EmailProviderSettingsHeaders, EmailProviderSettingsHeadersArgs

    XMcViewContentLink string
    Disable or enable the default View Content Link for sensitive emails.
    XSesConfigurationSet string
    SES Configuration set to include when sending emails.
    XMcViewContentLink string
    Disable or enable the default View Content Link for sensitive emails.
    XSesConfigurationSet string
    SES Configuration set to include when sending emails.
    xMcViewContentLink String
    Disable or enable the default View Content Link for sensitive emails.
    xSesConfigurationSet String
    SES Configuration set to include when sending emails.
    xMcViewContentLink string
    Disable or enable the default View Content Link for sensitive emails.
    xSesConfigurationSet string
    SES Configuration set to include when sending emails.
    x_mc_view_content_link str
    Disable or enable the default View Content Link for sensitive emails.
    x_ses_configuration_set str
    SES Configuration set to include when sending emails.
    xMcViewContentLink String
    Disable or enable the default View Content Link for sensitive emails.
    xSesConfigurationSet String
    SES Configuration set to include when sending emails.

    EmailProviderSettingsMessage, EmailProviderSettingsMessageArgs

    ConfigurationSetName string
    Setting for the ses email provider. The name of the configuration set to apply to the sent emails.
    ViewContentLink bool
    Setting for the mandrill email provider. Set to true to see the content of individual emails sent to users.
    ConfigurationSetName string
    Setting for the ses email provider. The name of the configuration set to apply to the sent emails.
    ViewContentLink bool
    Setting for the mandrill email provider. Set to true to see the content of individual emails sent to users.
    configurationSetName String
    Setting for the ses email provider. The name of the configuration set to apply to the sent emails.
    viewContentLink Boolean
    Setting for the mandrill email provider. Set to true to see the content of individual emails sent to users.
    configurationSetName string
    Setting for the ses email provider. The name of the configuration set to apply to the sent emails.
    viewContentLink boolean
    Setting for the mandrill email provider. Set to true to see the content of individual emails sent to users.
    configuration_set_name str
    Setting for the ses email provider. The name of the configuration set to apply to the sent emails.
    view_content_link bool
    Setting for the mandrill email provider. Set to true to see the content of individual emails sent to users.
    configurationSetName String
    Setting for the ses email provider. The name of the configuration set to apply to the sent emails.
    viewContentLink Boolean
    Setting for the mandrill email provider. Set to true to see the content of individual emails sent to users.

    Import

    As this is not a resource identifiable by an ID within the Auth0 Management API,

    email can be imported using a random string.

    We recommend Version 4 UUID

    Example:

    $ pulumi import auth0:index/emailProvider:EmailProvider my_email_provider "b4213dc2-2eed-42c3-9516-c6131a9ce0b0"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Auth0 pulumi/pulumi-auth0
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the auth0 Terraform Provider.
    auth0 logo
    Auth0 v3.8.3 published on Wednesday, Nov 6, 2024 by Pulumi
    pulumi/pulumi-auth0