okta.EmailCustomization
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. When a customization is created it can not be created with anis_default
value oftrue
if there is already a default customization. If an email customization is the last of the template type it can not be deleted. And theis_default
value can’t be set to false when updating the last remaining customization. To allow this resource to be more flexible set theforce_is_default
property tocreate
,destroy
, orcreate,destroy
. This will cause all the customizations to be reset/deleted for a create when there is acreate
value inforce_is_default
andis_default
istrue
. Likewise reset will be called for a delete when there is adelete
value inforce_is_default
andis_default
istrue
.
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:
- Brand
Id string Brand ID
- Template
Name 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"
- Example values:
- Body string
The body of the customization
- Force
Is stringDefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- Is
Default bool Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- Subject string
The subject of the customization
- Brand
Id string Brand ID
- Template
Name 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"
- Example values:
- Body string
The body of the customization
- Force
Is stringDefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- Is
Default bool Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- Subject string
The subject of the customization
- brand
Id String Brand ID
- template
Name 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"
- Example values:
- body String
The body of the customization
- force
Is StringDefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- is
Default Boolean Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- subject String
The subject of the customization
- brand
Id string Brand ID
- template
Name 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"
- Example values:
- body string
The body of the customization
- force
Is stringDefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- is
Default boolean Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- 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"
- Example values:
- body str
The body of the customization
- force_
is_ strdefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- is_
default bool Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- subject str
The subject of the customization
- brand
Id String Brand ID
- template
Name 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"
- Example values:
- body String
The body of the customization
- force
Is StringDefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- is
Default Boolean Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- 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:
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.
- Body string
The body of the customization
- Brand
Id string Brand ID
- Force
Is stringDefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- Is
Default bool Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- Links string
Link relations for this object - JSON HAL - Discoverable resources related to the email template
- Subject string
The subject of the customization
- Template
Name 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"
- Example values:
- Body string
The body of the customization
- Brand
Id string Brand ID
- Force
Is stringDefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- Is
Default bool Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- Links string
Link relations for this object - JSON HAL - Discoverable resources related to the email template
- Subject string
The subject of the customization
- Template
Name 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"
- Example values:
- body String
The body of the customization
- brand
Id String Brand ID
- force
Is StringDefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- is
Default Boolean Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- links String
Link relations for this object - JSON HAL - Discoverable resources related to the email template
- subject String
The subject of the customization
- template
Name 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"
- Example values:
- body string
The body of the customization
- brand
Id string Brand ID
- force
Is stringDefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- is
Default boolean Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- links string
Link relations for this object - JSON HAL - Discoverable resources related to the email template
- subject string
The subject of the customization
- template
Name 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"
- Example values:
- body str
The body of the customization
- brand_
id str Brand ID
- force_
is_ strdefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- is_
default bool Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- 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"
- Example values:
- body String
The body of the customization
- brand
Id String Brand ID
- force
Is StringDefault Force
is_default
on the create and delete operation by deleting all email customizations. See Note above explaing email customization API behavior and API documentation. Valid valuescreate
,delete
,create,delete
.- is
Default Boolean Whether the customization is the default
- Setting
is_default
to true when there is already a default customization will cause an error when this resource is created.
- Setting
- 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"
- Example values from supported languages:
- links String
Link relations for this object - JSON HAL - Discoverable resources related to the email template
- subject String
The subject of the customization
- template
Name 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"
- Example values:
Import
An email customization can be imported using the customization ID, brand ID and template name.
$ pulumi import okta:index/emailCustomization:EmailCustomization example <customization_id>/<brand_id>/<template_name>
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
okta
Terraform Provider.