1. Packages
  2. Okta Provider
  3. API Docs
  4. getEmailCustomization
Okta v6.1.0 published on Wednesday, Oct 29, 2025 by Pulumi

okta.getEmailCustomization

Start a Neo task
Explain and create an okta.getEmailCustomization resource
okta logo
Okta v6.1.0 published on Wednesday, Oct 29, 2025 by Pulumi

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const test = okta.getBrands({});
    const forgotPassword = test.then(test => okta.getEmailCustomizations({
        brandId: test.brands?.[0]?.id,
        templateName: "ForgotPassword",
    }));
    const forgotPasswordEn = Promise.all([test, forgotPassword]).then(([test, forgotPassword]) => okta.getEmailCustomization({
        brandId: test.brands?.[0]?.id,
        templateName: "ForgotPassword",
        customizationId: forgotPassword.emailCustomizations?.[0]?.id,
    }));
    
    import pulumi
    import pulumi_okta as okta
    
    test = okta.get_brands()
    forgot_password = okta.get_email_customizations(brand_id=test.brands[0].id,
        template_name="ForgotPassword")
    forgot_password_en = okta.get_email_customization(brand_id=test.brands[0].id,
        template_name="ForgotPassword",
        customization_id=forgot_password.email_customizations[0].id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		test, err := okta.GetBrands(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		forgotPassword, err := okta.GetEmailCustomizations(ctx, &okta.GetEmailCustomizationsArgs{
    			BrandId:      test.Brands[0].Id,
    			TemplateName: "ForgotPassword",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = okta.LookupEmailCustomization(ctx, &okta.LookupEmailCustomizationArgs{
    			BrandId:         test.Brands[0].Id,
    			TemplateName:    "ForgotPassword",
    			CustomizationId: forgotPassword.EmailCustomizations[0].Id,
    		}, nil)
    		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 test = Okta.GetBrands.Invoke();
    
        var forgotPassword = Okta.GetEmailCustomizations.Invoke(new()
        {
            BrandId = test.Apply(getBrandsResult => getBrandsResult.Brands[0]?.Id),
            TemplateName = "ForgotPassword",
        });
    
        var forgotPasswordEn = Okta.GetEmailCustomization.Invoke(new()
        {
            BrandId = test.Apply(getBrandsResult => getBrandsResult.Brands[0]?.Id),
            TemplateName = "ForgotPassword",
            CustomizationId = forgotPassword.Apply(getEmailCustomizationsResult => getEmailCustomizationsResult.EmailCustomizations[0]?.Id),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.OktaFunctions;
    import com.pulumi.okta.inputs.GetEmailCustomizationsArgs;
    import com.pulumi.okta.inputs.GetEmailCustomizationArgs;
    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) {
            final var test = OktaFunctions.getBrands(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);
    
            final var forgotPassword = OktaFunctions.getEmailCustomizations(GetEmailCustomizationsArgs.builder()
                .brandId(test.brands()[0].id())
                .templateName("ForgotPassword")
                .build());
    
            final var forgotPasswordEn = OktaFunctions.getEmailCustomization(GetEmailCustomizationArgs.builder()
                .brandId(test.brands()[0].id())
                .templateName("ForgotPassword")
                .customizationId(forgotPassword.emailCustomizations()[0].id())
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: okta:getBrands
          arguments: {}
      forgotPassword:
        fn::invoke:
          function: okta:getEmailCustomizations
          arguments:
            brandId: ${test.brands[0].id}
            templateName: ForgotPassword
      forgotPasswordEn:
        fn::invoke:
          function: okta:getEmailCustomization
          arguments:
            brandId: ${test.brands[0].id}
            templateName: ForgotPassword
            customizationId: ${forgotPassword.emailCustomizations[0].id}
    

    Using getEmailCustomization

    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 getEmailCustomization(args: GetEmailCustomizationArgs, opts?: InvokeOptions): Promise<GetEmailCustomizationResult>
    function getEmailCustomizationOutput(args: GetEmailCustomizationOutputArgs, opts?: InvokeOptions): Output<GetEmailCustomizationResult>
    def get_email_customization(brand_id: Optional[str] = None,
                                customization_id: Optional[str] = None,
                                template_name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetEmailCustomizationResult
    def get_email_customization_output(brand_id: Optional[pulumi.Input[str]] = None,
                                customization_id: Optional[pulumi.Input[str]] = None,
                                template_name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetEmailCustomizationResult]
    func LookupEmailCustomization(ctx *Context, args *LookupEmailCustomizationArgs, opts ...InvokeOption) (*LookupEmailCustomizationResult, error)
    func LookupEmailCustomizationOutput(ctx *Context, args *LookupEmailCustomizationOutputArgs, opts ...InvokeOption) LookupEmailCustomizationResultOutput

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

    public static class GetEmailCustomization 
    {
        public static Task<GetEmailCustomizationResult> InvokeAsync(GetEmailCustomizationArgs args, InvokeOptions? opts = null)
        public static Output<GetEmailCustomizationResult> Invoke(GetEmailCustomizationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEmailCustomizationResult> getEmailCustomization(GetEmailCustomizationArgs args, InvokeOptions options)
    public static Output<GetEmailCustomizationResult> getEmailCustomization(GetEmailCustomizationArgs args, InvokeOptions options)
    
    fn::invoke:
      function: okta:index/getEmailCustomization:getEmailCustomization
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BrandId string
    Brand ID
    CustomizationId string
    The ID of the customization
    TemplateName string
    Template Name
    BrandId string
    Brand ID
    CustomizationId string
    The ID of the customization
    TemplateName string
    Template Name
    brandId String
    Brand ID
    customizationId String
    The ID of the customization
    templateName String
    Template Name
    brandId string
    Brand ID
    customizationId string
    The ID of the customization
    templateName string
    Template Name
    brand_id str
    Brand ID
    customization_id str
    The ID of the customization
    template_name str
    Template Name
    brandId String
    Brand ID
    customizationId String
    The ID of the customization
    templateName String
    Template Name

    getEmailCustomization Result

    The following output properties are available:

    Body string
    The body of the customization
    BrandId string
    Brand ID
    CustomizationId string
    The ID of the customization
    Id string
    The ID of the customization
    IsDefault bool
    Whether the customization is the default
    Language string
    The language supported by the customization
    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
    Body string
    The body of the customization
    BrandId string
    Brand ID
    CustomizationId string
    The ID of the customization
    Id string
    The ID of the customization
    IsDefault bool
    Whether the customization is the default
    Language string
    The language supported by the customization
    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
    body String
    The body of the customization
    brandId String
    Brand ID
    customizationId String
    The ID of the customization
    id String
    The ID of the customization
    isDefault Boolean
    Whether the customization is the default
    language String
    The language supported by the customization
    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
    body string
    The body of the customization
    brandId string
    Brand ID
    customizationId string
    The ID of the customization
    id string
    The ID of the customization
    isDefault boolean
    Whether the customization is the default
    language string
    The language supported by the customization
    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
    body str
    The body of the customization
    brand_id str
    Brand ID
    customization_id str
    The ID of the customization
    id str
    The ID of the customization
    is_default bool
    Whether the customization is the default
    language str
    The language supported by the customization
    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
    body String
    The body of the customization
    brandId String
    Brand ID
    customizationId String
    The ID of the customization
    id String
    The ID of the customization
    isDefault Boolean
    Whether the customization is the default
    language String
    The language supported by the customization
    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

    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 v6.1.0 published on Wednesday, Oct 29, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate