Remove a Custom Email Domain From an Okta Brand Using the API
Last Updated:
Overview
Administrators may need to remove a custom email domain from a specific brand within an Okta environment. Remove the custom email domain by using the Brands API to retrieve the brand details, then update the configuration to clear the email domain values.
Applies To
- Okta Identity Engine (OIE)
- Okta Classic Engine
- Branding
- Custom Email Domain
- Application Programming Interface (API)
Solution
How is a custom email domain removed from a brand using the API?
Download the Brands API collection, retrieve the specific brand identifier, and execute an update request with the email domain values removed to complete this process.
- Download the Brands API Collection for Postman.
- Retrieve the Brand ID from the Admin Console by navigating to the specific brand and copying the value from the URL. Alternatively, use the Get Brands
GET {{url}}/api/v1/brandsAPI call. - Execute the Get Brand
GET {{url}}/api/v1/brands/{{brandId}}call and copy the API response as shown in the following example. - Execute the Update Brand
PUT {{url}}/api/v1/brands/{{brandId}}call and paste the copied API response into the body. - Remove the values from the
emailDomainIdandemailDomainsections to update the brand and successfully remove the email domain as demonstrated in the following example.
