Email

Creates an Okta Email Template.

This resource allows you to create and configure an Okta Email Template.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.Template.Email("example", new Okta.Template.EmailArgs
        {
            Translations = 
            {
                new Okta.Template.Inputs.EmailTranslationArgs
                {
                    Language = "en",
                    Subject = "Stuff",
                    Template = $"Hi {user.FirstName},<br/><br/>Blah blah {resetPasswordLink}",
                },
                new Okta.Template.Inputs.EmailTranslationArgs
                {
                    Language = "es",
                    Subject = "Cosas",
                    Template = $"Hola {user.FirstName},<br/><br/>Puedo ir al bano {resetPasswordLink}",
                },
            },
            Type = "email.forgotPassword",
        });
    }

}

Coming soon!

import pulumi
import pulumi_okta as okta

example = okta.template.Email("example",
    translations=[
        {
            "language": "en",
            "subject": "Stuff",
            "template": f"Hi {user['firstName']},<br/><br/>Blah blah {reset_password_link}",
        },
        {
            "language": "es",
            "subject": "Cosas",
            "template": f"Hola {user['firstName']},<br/><br/>Puedo ir al bano {reset_password_link}",
        },
    ],
    type="email.forgotPassword")
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.template.Email("example", {
    translations: [
        {
            language: "en",
            subject: "Stuff",
            template: "Hi ${user.firstName},<br/><br/>Blah blah ${resetPasswordLink}",
        },
        {
            language: "es",
            subject: "Cosas",
            template: "Hola ${user.firstName},<br/><br/>Puedo ir al bano ${resetPasswordLink}",
        },
    ],
    type: "email.forgotPassword",
});

Create a Email Resource

new Email(name: string, args: EmailArgs, opts?: CustomResourceOptions);
def Email(resource_name, opts=None, default_language=None, translations=None, type=None, __props__=None);
func NewEmail(ctx *Context, name string, args EmailArgs, opts ...ResourceOption) (*Email, error)
public Email(string name, EmailArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args EmailArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args EmailArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args EmailArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Email Resource Properties

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

Inputs

The Email resource accepts the following input properties:

Translations List<EmailTranslationArgs>

Set of translations for particular template.

Type string

Email template type

DefaultLanguage string

The default language, by default is set to "en".

Translations []EmailTranslation

Set of translations for particular template.

Type string

Email template type

DefaultLanguage string

The default language, by default is set to "en".

translations EmailTranslation[]

Set of translations for particular template.

type string

Email template type

defaultLanguage string

The default language, by default is set to "en".

translations List[EmailTranslation]

Set of translations for particular template.

type str

Email template type

default_language str

The default language, by default is set to "en".

Outputs

All input properties are implicitly available as output properties. Additionally, the Email 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing Email Resource

Get an existing Email 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?: EmailState, opts?: CustomResourceOptions): Email
static get(resource_name, id, opts=None, default_language=None, translations=None, type=None, __props__=None);
func GetEmail(ctx *Context, name string, id IDInput, state *EmailState, opts ...ResourceOption) (*Email, error)
public static Email Get(string name, Input<string> id, EmailState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

DefaultLanguage string

The default language, by default is set to "en".

Translations List<EmailTranslationArgs>

Set of translations for particular template.

Type string

Email template type

DefaultLanguage string

The default language, by default is set to "en".

Translations []EmailTranslation

Set of translations for particular template.

Type string

Email template type

defaultLanguage string

The default language, by default is set to "en".

translations EmailTranslation[]

Set of translations for particular template.

type string

Email template type

default_language str

The default language, by default is set to "en".

translations List[EmailTranslation]

Set of translations for particular template.

type str

Email template type

Supporting Types

EmailTranslation

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Language string

The language to map tthe template to.

Subject string

The email subject line.

Template string

The email body.

Language string

The language to map tthe template to.

Subject string

The email subject line.

Template string

The email body.

language string

The language to map tthe template to.

subject string

The email subject line.

template string

The email body.

language str

The language to map tthe template to.

subject str

The email subject line.

template str

The email body.

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes
This Pulumi package is based on the okta Terraform Provider.