settings

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

Overview

Name	settings
Type	Resource
Id	okta.org.settings

Fields

The following fields are returned by SELECT queries:

get_org_settings

Name	Datatype	Description
id	string	Org ID
_links	object	Specifies link relations (see Web Linking) available for the org using the JSON Hypertext Application Language specification
address1	string	Primary address of the organization associated with the org
address2	string	Secondary address of the organization associated with the org
city	string	City of the organization associated with the org
companyName	string	Name of org
country	string	County of the organization associated with the org
created	string (date-time)	When org was created
endUserSupportHelpURL	string	Support link of org
expiresAt	string (date-time)	Expiration of org
lastUpdated	string (date-time)	When org was last updated
phoneNumber	string	Phone number of the organization associated with the org
postalCode	string	Postal code of the organization associated with the org
state	string	State of the organization associated with the org
status	string	Status of org
subdomain	string	Subdomain of org
supportPhoneNumber	string	Support help phone of the organization associated with the org
website	string	Website of the organization associated with the org

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_org_settings	select	subdomain		Retrieves the Org General Settings
update_org_settings	update	subdomain		Updates partial Org General Settings
replace_org_settings	replace	subdomain		Replaces the Org General Settings for your Okta org

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_org_settings

Retrieves the Org General Settings

SELECT
id,
_links,
address1,
address2,
city,
companyName,
country,
created,
endUserSupportHelpURL,
expiresAt,
lastUpdated,
phoneNumber,
postalCode,
state,
status,
subdomain,
supportPhoneNumber,
website
FROM okta.org.settings
WHERE subdomain = '{{ subdomain }}' -- required
;

UPDATE examples

update_org_settings

Updates partial Org General Settings

UPDATE okta.org.settings
SET 
data__address1 = '{{ address1 }}',
data__address2 = '{{ address2 }}',
data__city = '{{ city }}',
data__companyName = '{{ companyName }}',
data__country = '{{ country }}',
data__endUserSupportHelpURL = '{{ endUserSupportHelpURL }}',
data__phoneNumber = '{{ phoneNumber }}',
data__postalCode = '{{ postalCode }}',
data__state = '{{ state }}',
data__supportPhoneNumber = '{{ supportPhoneNumber }}',
data__website = '{{ website }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
_links,
address1,
address2,
city,
companyName,
country,
created,
endUserSupportHelpURL,
expiresAt,
lastUpdated,
phoneNumber,
postalCode,
state,
status,
subdomain,
supportPhoneNumber,
website
;

REPLACE examples

replace_org_settings

Replaces the Org General Settings for your Okta org

REPLACE okta.org.settings
SET 
data__address1 = '{{ address1 }}',
data__address2 = '{{ address2 }}',
data__city = '{{ city }}',
data__companyName = '{{ companyName }}',
data__country = '{{ country }}',
data__endUserSupportHelpURL = '{{ endUserSupportHelpURL }}',
data__phoneNumber = '{{ phoneNumber }}',
data__postalCode = '{{ postalCode }}',
data__state = '{{ state }}',
data__supportPhoneNumber = '{{ supportPhoneNumber }}',
data__website = '{{ website }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
id,
_links,
address1,
address2,
city,
companyName,
country,
created,
endUserSupportHelpURL,
expiresAt,
lastUpdated,
phoneNumber,
postalCode,
state,
status,
subdomain,
supportPhoneNumber,
website
;