error_page
Creates, updates, deletes, gets or lists an error_page resource.
Overview​
| Name | error_page |
| Type | Resource |
| Id | okta.brands.error_page |
Fields​
The following fields are returned by SELECT queries:
- get_error_page
Successfully retrieved the error 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_error_page | select | brandId, subdomain | expand | Retrieves the error page sub-resources. The expand query parameter specifies which sub-resources to include in the response. |
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_error_page
Retrieves the error page sub-resources. The expand query parameter specifies which sub-resources to include in the response.
SELECT
_embedded,
_links
FROM okta.brands.error_page
WHERE brandId = '{{ brandId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
AND expand = '{{ expand }}'
;