1. Packages
  2. Okta Provider
  3. API Docs
  4. EmailTemplateSettings
Okta v4.13.1 published on Monday, Jan 27, 2025 by Pulumi

okta.EmailTemplateSettings

Explore with Pulumi AI

okta logo
Okta v4.13.1 published on Monday, Jan 27, 2025 by Pulumi

    Manages email template settings

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = new okta.EmailTemplateSettings("example", {
        brandId: "<brand id>",
        templateName: "ForgotPassword",
        recipients: "ADMINS_ONLY",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.EmailTemplateSettings("example",
        brand_id="<brand id>",
        template_name="ForgotPassword",
        recipients="ADMINS_ONLY")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.NewEmailTemplateSettings(ctx, "example", &okta.EmailTemplateSettingsArgs{
    			BrandId:      pulumi.String("<brand id>"),
    			TemplateName: pulumi.String("ForgotPassword"),
    			Recipients:   pulumi.String("ADMINS_ONLY"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Okta.EmailTemplateSettings("example", new()
        {
            BrandId = "<brand id>",
            TemplateName = "ForgotPassword",
            Recipients = "ADMINS_ONLY",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.EmailTemplateSettings;
    import com.pulumi.okta.EmailTemplateSettingsArgs;
    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) {
            var example = new EmailTemplateSettings("example", EmailTemplateSettingsArgs.builder()
                .brandId("<brand id>")
                .templateName("ForgotPassword")
                .recipients("ADMINS_ONLY")
                .build());
    
        }
    }
    
    resources:
      example:
        type: okta:EmailTemplateSettings
        properties:
          brandId: <brand id>
          templateName: ForgotPassword
          recipients: ADMINS_ONLY
    

    Create EmailTemplateSettings Resource

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

    Constructor syntax

    new EmailTemplateSettings(name: string, args: EmailTemplateSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def EmailTemplateSettings(resource_name: str,
                              args: EmailTemplateSettingsArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def EmailTemplateSettings(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              brand_id: Optional[str] = None,
                              recipients: Optional[str] = None,
                              template_name: Optional[str] = None)
    func NewEmailTemplateSettings(ctx *Context, name string, args EmailTemplateSettingsArgs, opts ...ResourceOption) (*EmailTemplateSettings, error)
    public EmailTemplateSettings(string name, EmailTemplateSettingsArgs args, CustomResourceOptions? opts = null)
    public EmailTemplateSettings(String name, EmailTemplateSettingsArgs args)
    public EmailTemplateSettings(String name, EmailTemplateSettingsArgs args, CustomResourceOptions options)
    
    type: okta:EmailTemplateSettings
    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 EmailTemplateSettingsArgs
    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 EmailTemplateSettingsArgs
    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 EmailTemplateSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailTemplateSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailTemplateSettingsArgs
    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 emailTemplateSettingsResource = new Okta.EmailTemplateSettings("emailTemplateSettingsResource", new()
    {
        BrandId = "string",
        Recipients = "string",
        TemplateName = "string",
    });
    
    example, err := okta.NewEmailTemplateSettings(ctx, "emailTemplateSettingsResource", &okta.EmailTemplateSettingsArgs{
    	BrandId:      pulumi.String("string"),
    	Recipients:   pulumi.String("string"),
    	TemplateName: pulumi.String("string"),
    })
    
    var emailTemplateSettingsResource = new EmailTemplateSettings("emailTemplateSettingsResource", EmailTemplateSettingsArgs.builder()
        .brandId("string")
        .recipients("string")
        .templateName("string")
        .build());
    
    email_template_settings_resource = okta.EmailTemplateSettings("emailTemplateSettingsResource",
        brand_id="string",
        recipients="string",
        template_name="string")
    
    const emailTemplateSettingsResource = new okta.EmailTemplateSettings("emailTemplateSettingsResource", {
        brandId: "string",
        recipients: "string",
        templateName: "string",
    });
    
    type: okta:EmailTemplateSettings
    properties:
        brandId: string
        recipients: string
        templateName: string
    

    EmailTemplateSettings 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 EmailTemplateSettings resource accepts the following input properties:

    BrandId string
    The ID of the brand.
    Recipients string
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    TemplateName string
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation
    BrandId string
    The ID of the brand.
    Recipients string
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    TemplateName string
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation
    brandId String
    The ID of the brand.
    recipients String
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    templateName String
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation
    brandId string
    The ID of the brand.
    recipients string
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    templateName string
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation
    brand_id str
    The ID of the brand.
    recipients str
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    template_name str
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation
    brandId String
    The ID of the brand.
    recipients String
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    templateName String
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EmailTemplateSettings 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 EmailTemplateSettings Resource

    Get an existing EmailTemplateSettings 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?: EmailTemplateSettingsState, opts?: CustomResourceOptions): EmailTemplateSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            brand_id: Optional[str] = None,
            recipients: Optional[str] = None,
            template_name: Optional[str] = None) -> EmailTemplateSettings
    func GetEmailTemplateSettings(ctx *Context, name string, id IDInput, state *EmailTemplateSettingsState, opts ...ResourceOption) (*EmailTemplateSettings, error)
    public static EmailTemplateSettings Get(string name, Input<string> id, EmailTemplateSettingsState? state, CustomResourceOptions? opts = null)
    public static EmailTemplateSettings get(String name, Output<String> id, EmailTemplateSettingsState state, CustomResourceOptions options)
    resources:  _:    type: okta:EmailTemplateSettings    get:      id: ${id}
    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:
    BrandId string
    The ID of the brand.
    Recipients string
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    TemplateName string
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation
    BrandId string
    The ID of the brand.
    Recipients string
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    TemplateName string
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation
    brandId String
    The ID of the brand.
    recipients String
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    templateName String
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation
    brandId string
    The ID of the brand.
    recipients string
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    templateName string
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation
    brand_id str
    The ID of the brand.
    recipients str
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    template_name str
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation
    brandId String
    The ID of the brand.
    recipients String
    The recipients the emails of this template will be sent to - Valid values: ALL_USERS, ADMINS_ONLY, NO_USERS
    templateName String
    Email template name - Example values: AccountLockout,ADForgotPassword,ADForgotPasswordDenied,ADSelfServiceUnlock,ADUserActivation,AuthenticatorEnrolled,AuthenticatorReset,ChangeEmailConfirmation,EmailChallenge,EmailChangeConfirmation,EmailFactorVerification,ForgotPassword,ForgotPasswordDenied,IGAReviewerEndNotification,IGAReviewerNotification,IGAReviewerPendingNotification,IGAReviewerReassigned,LDAPForgotPassword,LDAPForgotPasswordDenied,LDAPSelfServiceUnlock,LDAPUserActivation,MyAccountChangeConfirmation,NewSignOnNotification,OktaVerifyActivation,PasswordChanged,PasswordResetByAdmin,PendingEmailChange,RegistrationActivation,RegistrationEmailVerification,SelfServiceUnlock,SelfServiceUnlockOnUnlockedAccount,UserActivation

    Import

    $ pulumi import okta:index/emailTemplateSettings:EmailTemplateSettings example <brand_id>/<template_name>
    

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

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.13.1 published on Monday, Jan 27, 2025 by Pulumi