1. Packages
  2. Okta Provider
  3. API Docs
  4. getEmailCustomizations
Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi

okta.getEmailCustomizations

Explore with Pulumi AI

Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi

Get the email customizations of an email template belonging to a brand in an Okta organization.

Using getEmailCustomizations

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getEmailCustomizations(args: GetEmailCustomizationsArgs, opts?: InvokeOptions): Promise<GetEmailCustomizationsResult>
function getEmailCustomizationsOutput(args: GetEmailCustomizationsOutputArgs, opts?: InvokeOptions): Output<GetEmailCustomizationsResult>
Copy
def get_email_customizations(brand_id: Optional[str] = None,
                             template_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetEmailCustomizationsResult
def get_email_customizations_output(brand_id: Optional[pulumi.Input[str]] = None,
                             template_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetEmailCustomizationsResult]
Copy
func GetEmailCustomizations(ctx *Context, args *GetEmailCustomizationsArgs, opts ...InvokeOption) (*GetEmailCustomizationsResult, error)
func GetEmailCustomizationsOutput(ctx *Context, args *GetEmailCustomizationsOutputArgs, opts ...InvokeOption) GetEmailCustomizationsResultOutput
Copy

> Note: This function is named GetEmailCustomizations in the Go SDK.

public static class GetEmailCustomizations 
{
    public static Task<GetEmailCustomizationsResult> InvokeAsync(GetEmailCustomizationsArgs args, InvokeOptions? opts = null)
    public static Output<GetEmailCustomizationsResult> Invoke(GetEmailCustomizationsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEmailCustomizationsResult> getEmailCustomizations(GetEmailCustomizationsArgs args, InvokeOptions options)
public static Output<GetEmailCustomizationsResult> getEmailCustomizations(GetEmailCustomizationsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: okta:index/getEmailCustomizations:getEmailCustomizations
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

BrandId This property is required. string
Brand ID
TemplateName This property is required. string
Template Name
BrandId This property is required. string
Brand ID
TemplateName This property is required. string
Template Name
brandId This property is required. String
Brand ID
templateName This property is required. String
Template Name
brandId This property is required. string
Brand ID
templateName This property is required. string
Template Name
brand_id This property is required. str
Brand ID
template_name This property is required. str
Template Name
brandId This property is required. String
Brand ID
templateName This property is required. String
Template Name

getEmailCustomizations Result

The following output properties are available:

BrandId string
Brand ID
EmailCustomizations List<GetEmailCustomizationsEmailCustomization>
List of okta.EmailCustomization belonging to the named email template of the brand in the organization
Id string
The provider-assigned unique ID for this managed resource.
TemplateName string
Template Name
BrandId string
Brand ID
EmailCustomizations []GetEmailCustomizationsEmailCustomization
List of okta.EmailCustomization belonging to the named email template of the brand in the organization
Id string
The provider-assigned unique ID for this managed resource.
TemplateName string
Template Name
brandId String
Brand ID
emailCustomizations List<GetEmailCustomizationsEmailCustomization>
List of okta.EmailCustomization belonging to the named email template of the brand in the organization
id String
The provider-assigned unique ID for this managed resource.
templateName String
Template Name
brandId string
Brand ID
emailCustomizations GetEmailCustomizationsEmailCustomization[]
List of okta.EmailCustomization belonging to the named email template of the brand in the organization
id string
The provider-assigned unique ID for this managed resource.
templateName string
Template Name
brand_id str
Brand ID
email_customizations Sequence[GetEmailCustomizationsEmailCustomization]
List of okta.EmailCustomization belonging to the named email template of the brand in the organization
id str
The provider-assigned unique ID for this managed resource.
template_name str
Template Name
brandId String
Brand ID
emailCustomizations List<Property Map>
List of okta.EmailCustomization belonging to the named email template of the brand in the organization
id String
The provider-assigned unique ID for this managed resource.
templateName String
Template Name

Supporting Types

GetEmailCustomizationsEmailCustomization

Body This property is required. string
The body of the customization
Id This property is required. string
The ID of the customization
IsDefault This property is required. bool
Whether the customization is the default
Language This property is required. string
The language supported by the customization
Links This property is required. string
Link relations for this object - JSON HAL - Discoverable resources related to the email template
Subject This property is required. string
The subject of the customization
Body This property is required. string
The body of the customization
Id This property is required. string
The ID of the customization
IsDefault This property is required. bool
Whether the customization is the default
Language This property is required. string
The language supported by the customization
Links This property is required. string
Link relations for this object - JSON HAL - Discoverable resources related to the email template
Subject This property is required. string
The subject of the customization
body This property is required. String
The body of the customization
id This property is required. String
The ID of the customization
isDefault This property is required. Boolean
Whether the customization is the default
language This property is required. String
The language supported by the customization
links This property is required. String
Link relations for this object - JSON HAL - Discoverable resources related to the email template
subject This property is required. String
The subject of the customization
body This property is required. string
The body of the customization
id This property is required. string
The ID of the customization
isDefault This property is required. boolean
Whether the customization is the default
language This property is required. string
The language supported by the customization
links This property is required. string
Link relations for this object - JSON HAL - Discoverable resources related to the email template
subject This property is required. string
The subject of the customization
body This property is required. str
The body of the customization
id This property is required. str
The ID of the customization
is_default This property is required. bool
Whether the customization is the default
language This property is required. str
The language supported by the customization
links This property is required. str
Link relations for this object - JSON HAL - Discoverable resources related to the email template
subject This property is required. str
The subject of the customization
body This property is required. String
The body of the customization
id This property is required. String
The ID of the customization
isDefault This property is required. Boolean
Whether the customization is the default
language This property is required. String
The language supported by the customization
links This property is required. String
Link relations for this object - JSON HAL - Discoverable resources related to the email template
subject This property is required. String
The subject of the customization

Package Details

Repository
Okta pulumi/pulumi-okta
License
Apache-2.0
Notes
This Pulumi package is based on the okta Terraform Provider.
Okta v4.16.0 published on Wednesday, Apr 9, 2025 by Pulumi