preferences
Creates, updates, deletes, gets or lists a preferences resource.
Overview
| Name | preferences |
| Type | Resource |
| Id | okta.org.preferences |
Fields
The following fields are returned by SELECT queries:
- get_org_preferences
| Name | Datatype | Description |
|---|---|---|
_links | object | Specifies link relations (see Web Linking) available for this object using the JSON Hypertext Application Language specification |
showEndUserFooter | boolean | Indicates if the footer is shown on the End-User Dashboard |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_org_preferences | select | subdomain | Retrieves preferences of your Okta org | |
upload_org_logo | exec | subdomain, file | Uploads and replaces the logo for your organization | |
set_org_hide_okta_uifooter | exec | subdomain | Sets the preference to hide the Okta End-User Dashboard footer for all end users of your org | |
set_org_show_okta_uifooter | exec | subdomain | Sets the preference to show the Okta UI footer for all end users of your org |
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_org_preferences
Retrieves preferences of your Okta org
SELECT
_links,
showEndUserFooter
FROM okta.org.preferences
WHERE subdomain = '{{ subdomain }}' -- required
;
Lifecycle Methods
- upload_org_logo
- set_org_hide_okta_uifooter
- set_org_show_okta_uifooter
Uploads and replaces the logo for your organization
EXEC okta.org.preferences.upload_org_logo
@subdomain='{{ subdomain }}' --required
@@json=
'{
"file": "{{ file }}"
}'
;
Sets the preference to hide the Okta End-User Dashboard footer for all end users of your org
EXEC okta.org.preferences.set_org_hide_okta_uifooter
@subdomain='{{ subdomain }}' --required
;
Sets the preference to show the Okta UI footer for all end users of your org
EXEC okta.org.preferences.set_org_show_okta_uifooter
@subdomain='{{ subdomain }}' --required
;