sign_out_page_settings

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

Overview

Name	sign_out_page_settings
Type	Resource
Id	okta.brands.sign_out_page_settings

Fields

The following fields are returned by SELECT queries:

get_sign_out_page_settings

Successfully retrieved the sign-out page settings.

Name	Datatype	Description
type	string	(EXTERNALLY_HOSTED, OKTA_DEFAULT)
url	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sign_out_page_settings	select	brandId, subdomain		Retrieves the sign-out page settings
replace_sign_out_page_settings	replace	brandId, subdomain, type		Replaces the sign-out page 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
brandId	string	The ID of the brand
subdomain	string	(default: my-org)

SELECT examples

get_sign_out_page_settings

Retrieves the sign-out page settings

SELECT
type,
url
FROM okta.brands.sign_out_page_settings
WHERE brandId = '{{ brandId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

replace_sign_out_page_settings

Replaces the sign-out page settings

REPLACE okta.brands.sign_out_page_settings
SET 
type = '{{ type }}',
url = '{{ url }}'
WHERE 
brandId = '{{ brandId }}' --required
AND subdomain = '{{ subdomain }}' --required
AND type = '{{ type }}' --required
RETURNING
type,
url;