default_sign_in_page
Creates, updates, deletes, gets or lists a default_sign_in_page resource.
Overview​
| Name | default_sign_in_page |
| Type | Resource |
| Id | okta.brands.default_sign_in_page |
Fields​
The following fields are returned by SELECT queries:
- get_default_sign_in_page
Successfully retrieved the default 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. This value can be a wildcard (*), a major version range (for example, ^2), a major-only version (for example, 7), or a specific Major.Minor version (for example, 5.15). (pattern: ^(?:*|^?\d+(?:.\d+){0,2})$) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_default_sign_in_page | select | brandId, subdomain | Retrieves the default sign-in page. The default sign-in page appears when no customized sign-in page exists. |
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_default_sign_in_page
Retrieves the default sign-in page. The default sign-in page appears when no customized sign-in page exists.
SELECT
contentSecurityPolicySetting,
pageContent,
widgetCustomizations,
widgetVersion
FROM okta.brands.default_sign_in_page
WHERE brandId = '{{ brandId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;