preview_error_page

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

Overview

Name	preview_error_page
Type	Resource
Id	okta.brands.preview_error_page

Fields

The following fields are returned by SELECT queries:

get_preview_error_page

Successfully retrieved the preview 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_preview_error_page	select	subdomain		Retrieves the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/error/preview.
replace_preview_error_page	replace	subdomain		Replaces the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/error/preview.
delete_preview_error_page	delete	subdomain		Deletes the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/error/preview.

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_preview_error_page

Retrieves the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/error/preview.

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

REPLACE examples

replace_preview_error_page

Replaces the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/error/preview.

REPLACE okta.brands.preview_error_page
SET 
data__pageContent = '{{ pageContent }}',
data__contentSecurityPolicySetting = '{{ contentSecurityPolicySetting }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
contentSecurityPolicySetting,
pageContent
;

DELETE examples

delete_preview_error_page

Deletes the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/error/preview.

DELETE FROM okta.brands.preview_error_page
WHERE subdomain = '{{ subdomain }}' --required
;