sign_in_page

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

Overview

Name	sign_in_page
Type	Resource
Id	okta.brands.sign_in_page

Fields

The following fields are returned by SELECT queries:

get_sign_in_page

Successfully retrieved the sign-in page.

Name	Datatype	Description
_embedded	object
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sign_in_page	select	brandId, subdomain	expand	Retrieves the sign-in page sub-resources. The expand query parameter specifies which sub-resources to include in the response.
delete_customized_sign_in_page	delete	brandId, subdomain		Deletes the customized sign-in page. As a result, the default sign-in 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)
expand	array	Specifies additional metadata to be included in the response

SELECT examples

get_sign_in_page

Retrieves the sign-in page sub-resources. The expand query parameter specifies which sub-resources to include in the response.

SELECT
_embedded,
_links
FROM okta.brands.sign_in_page
WHERE brandId = '{{ brandId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND expand = '{{ expand }}'
;

DELETE examples

delete_customized_sign_in_page

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

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