communication_settings

Creates, updates, deletes, gets or lists a communication_settings resource.

Overview

Name	communication_settings
Type	Resource
Id	okta.org.communication_settings

Fields

The following fields are returned by SELECT queries:

get_okta_communication_settings

Name	Datatype	Description
_links	object	Specifies link relations (see Web Linking) available for this object using the JSON Hypertext Application Language specification
optOutEmailUsers	boolean	Indicates whether org users receive Okta communication emails

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_okta_communication_settings	select	subdomain		Retrieves Okta Communication Settings of your org
opt_in_users_to_okta_communication_emails	exec	subdomain		Opts in all users of this org to Okta communication emails
opt_out_users_from_okta_communication_emails	exec	subdomain		Opts out all users of this org from Okta communication emails

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	(default: my-org)

SELECT examples

get_okta_communication_settings

Retrieves Okta Communication Settings of your org

SELECT
_links,
optOutEmailUsers
FROM okta.org.communication_settings
WHERE subdomain = '{{ subdomain }}' -- required
;

Lifecycle Methods

opt_in_users_to_okta_communication_emails

Opts in all users of this org to Okta communication emails

EXEC okta.org.communication_settings.opt_in_users_to_okta_communication_emails 
@subdomain='{{ subdomain }}' --required
;

opt_out_users_from_okta_communication_emails

Opts out all users of this org from Okta communication emails

EXEC okta.org.communication_settings.opt_out_users_from_okta_communication_emails 
@subdomain='{{ subdomain }}' --required
;