<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content
How to Copy a Custom Email Sender Domain to the Okta Default Brand
Okta Classic Engine
Okta Identity Engine
Custom Email Domain
Overview

In an environment where a custom email sender is configured for a custom brand, it is possible to copy the email sender domain to other custom brands.

The option to copy the sender to the Okta subdomain, however, is not possible through the user interface (UI). 

This article provides steps for using the API to copy the sender email. 

Applies To
  • Custom email
Solution
  1. Navigate to Okta Public API Collections.
  2. Sign in to Postman. 
  3. The API calls can be run through the Postman web or desktop applications. 

Okta Public API Collection

  1. Add the collection to the desired workspace. 
  2. If assistance is required, please see Postman Integration or refer to the article in the Related References section below.
  3. Once the correct parameters for the URL and authorization token are set, the process of collecting the IDs of the properties involved can begin. 
  4. Navigate to Email Domains > List all Email Domains. This will provide a full list of the custom email sender domains configured on this tenant. 
  5. Search for the domain that has the following property set to Verified and copy the ID of the verified email domain, which is the custom email sender address in question:  
    • "validationStatus": "VERIFIED"

Validation Status

  1. Next, we will find the ID of the Default Okta brand on the tenant. 
  2. Within the API collection, navigate to Brands > Brand Operations > Get Brands.
  3. Search for the brand that has the following property set to True and copy the ID of the associated brand:  
    • "isDefault": true

API Call

  1. Within the API collection, navigate to Brands > Brand Operations > Update/Replace Brand
  2. Within the URL, update the brand ID with the ID of the default brand within the tenant. 
  3. Within the payload of the API call, update the custom email domain ID with the verified email ID from the first API call made.  
    • "name": "Brand Name",
    • "emailDomainId": "Custom email domain ID"

 API Call payload  

  1. Run the API call.
  2. Navigate to the Admin console to verify the change. 
  3. Navigate to Customizations > Brands
  4. The email Address field should now show the custom email sender applied to both the custom domain and the Default Okta domain. 
  5. Customized emails can now be sent. 

 

Related References

 

Loading
How to Copy a Custom Email Sender Domain to the Okta Default Brand