Docs Packages
  1. Packages
  2. Okta
  3. API Docs
  4. EmailCustomization
Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-okta

okta.EmailCustomization

Explore with Pulumi AI

okta logo
Okta v4.4.0 published on Monday, Sep 18, 2023 by Pulumi
pulumi/pulumi-okta

    Use this resource to create an email customization of an email template belonging to a brand in an Okta organization.

    Okta’s public API is strict regarding the behavior of the is_default property in an email customization. Make use of depends_on meta argument to ensure the provider navigates email customization language versions seamlessly. Have all secondary customizations depend on the primary customization that is marked default. See Example Usage.

    Caveats for creating an email customization. If this is the first customization being created for the email template, and is_default is not set for the customization in its resource configuration, the API will respond with the created customization marked as default. The API will 400 if the language parameter is not one of the supported languages or the body parameter does not contain a required variable reference. The API will error 409 if is_default is true and a default customization exists. The API will 404 for an invalid brand_id or template_name.

    Caveats for updating an email customization. If the is_default parameter is true, the previous default email customization has its is_default set to false (see previous note about mitigating this with depends_on meta argument). The API will 409 if there’s already another email customization for the specified language or the is_default parameter is false and the email customization being updated is the default. The API will 400 if the language parameter is not one of the supported locales or the body parameter does not contain a required variable reference. The API will 404 for an invalid brand_id or template_name.

    Create EmailCustomization Resource

    new EmailCustomization(name: string, args: EmailCustomizationArgs, opts?: CustomResourceOptions);
    @overload
def EmailCustomization(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       body: Optional[str] = None,
                       brand_id: Optional[str] = None,
                       force_is_default: Optional[str] = None,
                       is_default: Optional[bool] = None,
                       language: Optional[str] = None,
                       subject: Optional[str] = None,
                       template_name: Optional[str] = None)
@overload
def EmailCustomization(resource_name: str,
                       args: EmailCustomizationArgs,
                       opts: Optional[ResourceOptions] = None)
    func NewEmailCustomization(ctx *Context, name string, args EmailCustomizationArgs, opts ...ResourceOption) (*EmailCustomization, error)
    public EmailCustomization(string name, EmailCustomizationArgs args, CustomResourceOptions? opts = null)
    public EmailCustomization(String name, EmailCustomizationArgs args)
public EmailCustomization(String name, EmailCustomizationArgs args, CustomResourceOptions options)

    type: okta:EmailCustomization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailCustomizationArgs
    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 EmailCustomizationArgs
    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 EmailCustomizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EmailCustomizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EmailCustomizationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    EmailCustomization Resource Properties

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

    Inputs

    The EmailCustomization resource accepts the following input properties:

    BrandId string

    Brand ID

    TemplateName string

    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"
    Body string

    The body of the customization

    ForceIsDefault string

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    IsDefault bool

    Whether the customization is the default

    Language string

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    Subject string

    The subject of the customization

    BrandId string

    Brand ID

    TemplateName string

    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"
    Body string

    The body of the customization

    ForceIsDefault string

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    IsDefault bool

    Whether the customization is the default

    Language string

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    Subject string

    The subject of the customization

    brandId String

    Brand ID

    templateName String

    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"
    body String

    The body of the customization

    forceIsDefault String

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    isDefault Boolean

    Whether the customization is the default

    language String

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    subject String

    The subject of the customization

    brandId string

    Brand ID

    templateName string

    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"
    body string

    The body of the customization

    forceIsDefault string

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    isDefault boolean

    Whether the customization is the default

    language string

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    subject string

    The subject of the customization

    brand_id str

    Brand ID

    template_name str

    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"
    body str

    The body of the customization

    force_is_default str

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    is_default bool

    Whether the customization is the default

    language str

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    subject str

    The subject of the customization

    brandId String

    Brand ID

    templateName String

    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"
    body String

    The body of the customization

    forceIsDefault String

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    isDefault Boolean

    Whether the customization is the default

    language String

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    subject String

    The subject of the customization

    Outputs

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

    Id string

    The provider-assigned unique ID for this managed resource.

    Links string

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    Id string

    The provider-assigned unique ID for this managed resource.

    Links string

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    id String

    The provider-assigned unique ID for this managed resource.

    links String

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    id string

    The provider-assigned unique ID for this managed resource.

    links string

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    id str

    The provider-assigned unique ID for this managed resource.

    links str

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    id String

    The provider-assigned unique ID for this managed resource.

    links String

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    Look up Existing EmailCustomization Resource

    Get an existing EmailCustomization 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?: EmailCustomizationState, opts?: CustomResourceOptions): EmailCustomization
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        body: Optional[str] = None,
        brand_id: Optional[str] = None,
        force_is_default: Optional[str] = None,
        is_default: Optional[bool] = None,
        language: Optional[str] = None,
        links: Optional[str] = None,
        subject: Optional[str] = None,
        template_name: Optional[str] = None) -> EmailCustomization
    func GetEmailCustomization(ctx *Context, name string, id IDInput, state *EmailCustomizationState, opts ...ResourceOption) (*EmailCustomization, error)
    public static EmailCustomization Get(string name, Input<string> id, EmailCustomizationState? state, CustomResourceOptions? opts = null)
    public static EmailCustomization get(String name, Output<String> id, EmailCustomizationState 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:
    Body string

    The body of the customization

    BrandId string

    Brand ID

    ForceIsDefault string

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    IsDefault bool

    Whether the customization is the default

    Language string

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    Links string

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    Subject string

    The subject of the customization

    TemplateName string

    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"
    Body string

    The body of the customization

    BrandId string

    Brand ID

    ForceIsDefault string

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    IsDefault bool

    Whether the customization is the default

    Language string

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    Links string

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    Subject string

    The subject of the customization

    TemplateName string

    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"
    body String

    The body of the customization

    brandId String

    Brand ID

    forceIsDefault String

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    isDefault Boolean

    Whether the customization is the default

    language String

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    links String

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    subject String

    The subject of the customization

    templateName String

    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"
    body string

    The body of the customization

    brandId string

    Brand ID

    forceIsDefault string

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    isDefault boolean

    Whether the customization is the default

    language string

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    links string

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    subject string

    The subject of the customization

    templateName string

    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"
    body str

    The body of the customization

    brand_id str

    Brand ID

    force_is_default str

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    is_default bool

    Whether the customization is the default

    language str

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    links str

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    subject str

    The subject of the customization

    template_name str

    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"
    body String

    The body of the customization

    brandId String

    Brand ID

    forceIsDefault String

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template",

    Deprecated:

    force_is_default is deprecated and now is a no-op in behavior. Rely upon the depends_on meta argument to force dependency of secondary templates to the default template

    isDefault Boolean

    Whether the customization is the default

    language String

    The language supported by the customization

    • Example values from supported languages: "cs", "da", "de", "el", "en", "es", "fi", "fr", "hu", "id", "it", "ja", "ko", "ms", "nb", "nl-NL", "pl", "pt-BR", "ro", "ru", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-TW"
    links String

    Link relations for this object - JSON HAL - Discoverable resources related to the email template

    subject String

    The subject of the customization

    templateName String

    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

    An email customization can be imported using the customization ID, brand ID and template name.

     $ pulumi import okta:index/emailCustomization:EmailCustomization example &#60;customization_id&#62;/&#60;brand_id&#62;/&#60;template_name&#62;

    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.4.0 published on Monday, Sep 18, 2023 by Pulumi
    pulumi/pulumi-okta