email_settings

Creates, updates, deletes, gets or lists an email_settings resource.

Overview

Name	email_settings
Type	Resource
Id	okta.brands.email_settings

Fields

The following fields are returned by SELECT queries:

get_email_settings

Successfully retrieved the email template's settings.

Name	Datatype	Description
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
recipients	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_email_settings	select	subdomain		Retrieves an email template's settings
replace_email_settings	replace	subdomain, data__recipients		Replaces an email template's settings

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

SELECT examples

get_email_settings

Retrieves an email template's settings

SELECT
_links,
recipients
FROM okta.brands.email_settings
WHERE subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

replace_email_settings

Replaces an email template's settings

REPLACE okta.brands.email_settings
SET 
data__recipients = '{{ recipients }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND data__recipients = '{{ recipients }}' --required
RETURNING
recipients
;