preview_sign_in_page

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

Overview

Name	preview_sign_in_page
Type	Resource
Id	okta.brands.preview_sign_in_page

Fields

The following fields are returned by SELECT queries:

get_preview_sign_in_page

Successfully retrieved the preview sign-in page.

Name	Datatype	Description
contentSecurityPolicySetting	object
pageContent	string	The HTML for the page
widgetCustomizations	object
widgetVersion	string	The version specified as a Semantic Version. (pattern: ^(0|[1-9]\d*).(0|[1-9]\d*).(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-])(?:.(?:0|[1-9]\d|\d*[a-zA-Z-][0-9a-zA-Z-]))))?(?:+([0-9a-zA-Z-]+(?:.[0-9a-zA-Z-]+)*))?$)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_preview_sign_in_page	select	subdomain		Retrieves the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/login/preview.
replace_preview_sign_in_page	replace	subdomain		Replaces the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/login/preview.
delete_preview_sign_in_page	delete	subdomain		Deletes the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at ${yourOktaDomain}/login/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_sign_in_page

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

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

REPLACE examples

replace_preview_sign_in_page

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

REPLACE okta.brands.preview_sign_in_page
SET 
data__pageContent = '{{ pageContent }}',
data__contentSecurityPolicySetting = '{{ contentSecurityPolicySetting }}',
data__widgetCustomizations = '{{ widgetCustomizations }}',
data__widgetVersion = '{{ widgetVersion }}'
WHERE 
subdomain = '{{ subdomain }}' --required
RETURNING
contentSecurityPolicySetting,
pageContent,
widgetCustomizations,
widgetVersion
;

DELETE examples

delete_preview_sign_in_page

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

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