customized_error_page

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

Overview

Name	customized_error_page
Type	Resource
Id	okta.brands.customized_error_page

Fields

The following fields are returned by SELECT queries:

get_customized_error_page

Successfully retrieved the customized error page.

Name	Datatype	Description
contentSecurityPolicySetting	object
pageContent	string	The HTML for the page

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_customized_error_page	select	brandId, subdomain		Retrieves the customized error page. The customized error page appears in your live environment.
replace_customized_error_page	replace	brandId, subdomain		Replaces the customized error page. The customized error page appears in your live environment.
delete_customized_error_page	delete	brandId, subdomain		Deletes the customized error page. As a result, the default error page appears in your live environment.

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_customized_error_page

Retrieves the customized error page. The customized error page appears in your live environment.

SELECT
contentSecurityPolicySetting,
pageContent
FROM okta.brands.customized_error_page
WHERE brandId = '{{ brandId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

replace_customized_error_page

Replaces the customized error page. The customized error page appears in your live environment.

REPLACE okta.brands.customized_error_page
SET 
pageContent = '{{ pageContent }}',
contentSecurityPolicySetting = '{{ contentSecurityPolicySetting }}'
WHERE 
brandId = '{{ brandId }}' --required
AND subdomain = '{{ subdomain }}' --required
RETURNING
contentSecurityPolicySetting,
pageContent;

DELETE examples

delete_customized_error_page

Deletes the customized error page. As a result, the default error page appears in your live environment.

DELETE FROM okta.brands.customized_error_page
WHERE brandId = '{{ brandId }}' --required
AND subdomain = '{{ subdomain }}' --required
;