themes

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

Overview

Name	themes
Type	Resource
Id	okta.brands.themes

Fields

The following fields are returned by SELECT queries:

get_brand_theme

Successfully retrieved the theme

Name	Datatype	Description
id	string
_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.
backgroundImage	string
emailTemplateTouchPointVariant	string	Variant for email templates. You can publish a theme for email templates with different combinations of assets. Variants are preset combinations of those assets. (FULL_THEME, OKTA_DEFAULT) (default: OKTA_DEFAULT)
endUserDashboardTouchPointVariant	string	Variant for the Okta End-User Dashboard. You can publish a theme for end-user dashboard with different combinations of assets. Variants are preset combinations of those assets. (FULL_THEME, LOGO_ON_FULL_WHITE_BACKGROUND, OKTA_DEFAULT, WHITE_LOGO_BACKGROUND) (default: OKTA_DEFAULT)
errorPageTouchPointVariant	string	Variant for the error page. You can publish a theme for error page with different combinations of assets. Variants are preset combinations of those assets. (BACKGROUND_IMAGE, BACKGROUND_SECONDARY_COLOR, OKTA_DEFAULT) (default: OKTA_DEFAULT)
favicon	string
loadingPageTouchPointVariant	string	Variant for the Okta loading page. You can publish a theme for Okta loading page with different combinations of assets. Variants are preset combinations of those assets. (NONE, OKTA_DEFAULT) (default: OKTA_DEFAULT)
logo	string
primaryColorContrastHex	string	Primary color contrast hex code
primaryColorHex	string	Primary color hex code
secondaryColorContrastHex	string	Secondary color contrast hex code
secondaryColorHex	string	Secondary color hex code
signInPageTouchPointVariant	string	Variant for the Okta sign-in page. You can publish a theme for sign-in page with different combinations of assets. Variants are preset combinations of those assets. > Note: For a non-OKTA_DEFAULT variant, primaryColorHex is used for button background color and primaryColorContrastHex is used to optimize the opacity for button text. (BACKGROUND_IMAGE, BACKGROUND_SECONDARY_COLOR, OKTA_DEFAULT)

list_brand_themes

Name	Datatype	Description
id	string
_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.
backgroundImage	string
emailTemplateTouchPointVariant	string	Variant for email templates. You can publish a theme for email templates with different combinations of assets. Variants are preset combinations of those assets. (FULL_THEME, OKTA_DEFAULT) (default: OKTA_DEFAULT)
endUserDashboardTouchPointVariant	string	Variant for the Okta End-User Dashboard. You can publish a theme for end-user dashboard with different combinations of assets. Variants are preset combinations of those assets. (FULL_THEME, LOGO_ON_FULL_WHITE_BACKGROUND, OKTA_DEFAULT, WHITE_LOGO_BACKGROUND) (default: OKTA_DEFAULT)
errorPageTouchPointVariant	string	Variant for the error page. You can publish a theme for error page with different combinations of assets. Variants are preset combinations of those assets. (BACKGROUND_IMAGE, BACKGROUND_SECONDARY_COLOR, OKTA_DEFAULT) (default: OKTA_DEFAULT)
favicon	string
loadingPageTouchPointVariant	string	Variant for the Okta loading page. You can publish a theme for Okta loading page with different combinations of assets. Variants are preset combinations of those assets. (NONE, OKTA_DEFAULT) (default: OKTA_DEFAULT)
logo	string
primaryColorContrastHex	string	Primary color contrast hex code
primaryColorHex	string	Primary color hex code
secondaryColorContrastHex	string	Secondary color contrast hex code
secondaryColorHex	string	Secondary color hex code
signInPageTouchPointVariant	string	Variant for the Okta sign-in page. You can publish a theme for sign-in page with different combinations of assets. Variants are preset combinations of those assets. > Note: For a non-OKTA_DEFAULT variant, primaryColorHex is used for button background color and primaryColorContrastHex is used to optimize the opacity for button text. (BACKGROUND_IMAGE, BACKGROUND_SECONDARY_COLOR, OKTA_DEFAULT)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_brand_theme	select	brandId, themeId, subdomain		Retrieves a theme for a brand
list_brand_themes	select	brandId, subdomain		Lists all the themes in your brand. > Important: Currently each org supports only one theme, therefore this contains a single object only.
replace_brand_theme	replace	brandId, themeId, subdomain, primaryColorHex, secondaryColorHex, signInPageTouchPointVariant, endUserDashboardTouchPointVariant, errorPageTouchPointVariant, emailTemplateTouchPointVariant		Replaces a theme for a brand
upload_brand_theme_background_image	exec	brandId, themeId, subdomain, file		Uploads and replaces the background image for the theme. The file must be in PNG, JPG, or GIF format and less than 2 MB in size.
delete_brand_theme_background_image	exec	brandId, themeId, subdomain		Deletes a theme background image
upload_brand_theme_favicon	exec	brandId, themeId, subdomain, file		Uploads and replaces the favicon for the theme
delete_brand_theme_favicon	exec	brandId, themeId, subdomain		Deletes a theme favicon. The theme will use the default Okta favicon.
upload_brand_theme_logo	exec	brandId, themeId, subdomain, file		Uploads and replaces the logo for the theme. The file must be in PNG, JPG, or GIF format and less than 100kB in size. For best results use landscape orientation, a transparent background, and a minimum size of 300px by 50px to prevent upscaling.
delete_brand_theme_logo	exec	brandId, themeId, subdomain		Deletes a Theme logo. The theme will use the default Okta logo.

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)
themeId	string	The ID of the theme

SELECT examples

get_brand_theme

Retrieves a theme for a brand

SELECT
id,
_links,
backgroundImage,
emailTemplateTouchPointVariant,
endUserDashboardTouchPointVariant,
errorPageTouchPointVariant,
favicon,
loadingPageTouchPointVariant,
logo,
primaryColorContrastHex,
primaryColorHex,
secondaryColorContrastHex,
secondaryColorHex,
signInPageTouchPointVariant
FROM okta.brands.themes
WHERE brandId = '{{ brandId }}' -- required
AND themeId = '{{ themeId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_brand_themes

Lists all the themes in your brand.

> Important: Currently each org supports only one theme, therefore this contains a single object only.

SELECT
id,
_links,
backgroundImage,
emailTemplateTouchPointVariant,
endUserDashboardTouchPointVariant,
errorPageTouchPointVariant,
favicon,
loadingPageTouchPointVariant,
logo,
primaryColorContrastHex,
primaryColorHex,
secondaryColorContrastHex,
secondaryColorHex,
signInPageTouchPointVariant
FROM okta.brands.themes
WHERE brandId = '{{ brandId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

REPLACE examples

replace_brand_theme

Replaces a theme for a brand

REPLACE okta.brands.themes
SET 
emailTemplateTouchPointVariant = '{{ emailTemplateTouchPointVariant }}',
endUserDashboardTouchPointVariant = '{{ endUserDashboardTouchPointVariant }}',
errorPageTouchPointVariant = '{{ errorPageTouchPointVariant }}',
loadingPageTouchPointVariant = '{{ loadingPageTouchPointVariant }}',
primaryColorContrastHex = '{{ primaryColorContrastHex }}',
primaryColorHex = '{{ primaryColorHex }}',
secondaryColorContrastHex = '{{ secondaryColorContrastHex }}',
secondaryColorHex = '{{ secondaryColorHex }}',
signInPageTouchPointVariant = '{{ signInPageTouchPointVariant }}'
WHERE 
brandId = '{{ brandId }}' --required
AND themeId = '{{ themeId }}' --required
AND subdomain = '{{ subdomain }}' --required
AND primaryColorHex = '{{ primaryColorHex }}' --required
AND secondaryColorHex = '{{ secondaryColorHex }}' --required
AND signInPageTouchPointVariant = '{{ signInPageTouchPointVariant }}' --required
AND endUserDashboardTouchPointVariant = '{{ endUserDashboardTouchPointVariant }}' --required
AND errorPageTouchPointVariant = '{{ errorPageTouchPointVariant }}' --required
AND emailTemplateTouchPointVariant = '{{ emailTemplateTouchPointVariant }}' --required
RETURNING
id,
_links,
backgroundImage,
emailTemplateTouchPointVariant,
endUserDashboardTouchPointVariant,
errorPageTouchPointVariant,
favicon,
loadingPageTouchPointVariant,
logo,
primaryColorContrastHex,
primaryColorHex,
secondaryColorContrastHex,
secondaryColorHex,
signInPageTouchPointVariant;

Lifecycle Methods

upload_brand_theme_background_image

Uploads and replaces the background image for the theme. The file must be in PNG, JPG, or GIF format and less than 2 MB in size.

EXEC okta.brands.themes.upload_brand_theme_background_image 
@brandId='{{ brandId }}' --required, 
@themeId='{{ themeId }}' --required, 
@subdomain='{{ subdomain }}' --required 
@@json=
'{
"file": "{{ file }}"
}'
;

delete_brand_theme_background_image

Deletes a theme background image

EXEC okta.brands.themes.delete_brand_theme_background_image 
@brandId='{{ brandId }}' --required, 
@themeId='{{ themeId }}' --required, 
@subdomain='{{ subdomain }}' --required
;

upload_brand_theme_favicon

Uploads and replaces the favicon for the theme

EXEC okta.brands.themes.upload_brand_theme_favicon 
@brandId='{{ brandId }}' --required, 
@themeId='{{ themeId }}' --required, 
@subdomain='{{ subdomain }}' --required 
@@json=
'{
"file": "{{ file }}"
}'
;

delete_brand_theme_favicon

Deletes a theme favicon. The theme will use the default Okta favicon.

EXEC okta.brands.themes.delete_brand_theme_favicon 
@brandId='{{ brandId }}' --required, 
@themeId='{{ themeId }}' --required, 
@subdomain='{{ subdomain }}' --required
;

upload_brand_theme_logo

Uploads and replaces the logo for the theme. The file must be in PNG, JPG, or GIF format and less than 100kB in size. For best results use landscape orientation, a transparent background, and a minimum size of 300px by 50px to prevent upscaling.

EXEC okta.brands.themes.upload_brand_theme_logo 
@brandId='{{ brandId }}' --required, 
@themeId='{{ themeId }}' --required, 
@subdomain='{{ subdomain }}' --required 
@@json=
'{
"file": "{{ file }}"
}'
;

delete_brand_theme_logo

Deletes a Theme logo. The theme will use the default Okta logo.

EXEC okta.brands.themes.delete_brand_theme_logo 
@brandId='{{ brandId }}' --required, 
@themeId='{{ themeId }}' --required, 
@subdomain='{{ subdomain }}' --required
;