com.okta.sdk.resource.brand

Interface Theme

All Superinterfaces:

ExtensibleResource, Map<String,Object>, PropertyRetriever, Resource

All Known Implementing Classes:

DefaultTheme

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00")
public interface Theme
extends ExtensibleResource

Theme

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
void	deleteBrandThemeBackgroundImage(String brandId, String themeId) Deletes a Theme background image Deletes a Theme background image
void	deleteBrandThemeFavicon(String brandId, String themeId) Deletes a Theme favicon.
void	deleteBrandThemeLogo(String brandId, String themeId) Deletes a Theme logo.
String	getBackgroundImage()
EmailTemplateTouchPointVariant	getEmailTemplateTouchPointVariant()
EndUserDashboardTouchPointVariant	getEndUserDashboardTouchPointVariant()
ErrorPageTouchPointVariant	getErrorPageTouchPointVariant()
Map<String,Object>	getLinks()
String	getPrimaryColorContrastHex()
String	getPrimaryColorHex()
String	getSecondaryColorContrastHex()
String	getSecondaryColorHex()
SignInPageTouchPointVariant	getSignInPageTouchPointVariant()
Theme	setEmailTemplateTouchPointVariant(EmailTemplateTouchPointVariant emailTemplateTouchPointVariant)
Theme	setEndUserDashboardTouchPointVariant(EndUserDashboardTouchPointVariant endUserDashboardTouchPointVariant)
Theme	setErrorPageTouchPointVariant(ErrorPageTouchPointVariant errorPageTouchPointVariant)
Theme	setPrimaryColorContrastHex(String primaryColorContrastHex)
Theme	setPrimaryColorHex(String primaryColorHex)
Theme	setSecondaryColorContrastHex(String secondaryColorContrastHex)
Theme	setSecondaryColorHex(String secondaryColorHex)
Theme	setSignInPageTouchPointVariant(SignInPageTouchPointVariant signInPageTouchPointVariant)
ThemeResponse	update(String brandId, String themeId, Theme theme) Update a theme for a brand Updates a theme for a brand
ImageUploadResponse	updateBrandThemeBackgroundImage(String brandId, String themeId, File file) Updates the background image for your Theme Updates the background image for your Theme
ImageUploadResponse	updateBrandThemeFavicon(String brandId, String themeId, File file) Updates the favicon for your theme Updates the favicon for your theme
ImageUploadResponse	uploadBrandThemeLogo(String brandId, String themeId, File file) Update a themes logo Updates the logo for your Theme

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

getLinks

Map<String,Object> getLinks()

getBackgroundImage

String getBackgroundImage()

getEmailTemplateTouchPointVariant

EmailTemplateTouchPointVariant getEmailTemplateTouchPointVariant()

setEmailTemplateTouchPointVariant

Theme setEmailTemplateTouchPointVariant(EmailTemplateTouchPointVariant emailTemplateTouchPointVariant)

getEndUserDashboardTouchPointVariant

EndUserDashboardTouchPointVariant getEndUserDashboardTouchPointVariant()

setEndUserDashboardTouchPointVariant

Theme setEndUserDashboardTouchPointVariant(EndUserDashboardTouchPointVariant endUserDashboardTouchPointVariant)

getErrorPageTouchPointVariant

ErrorPageTouchPointVariant getErrorPageTouchPointVariant()

setErrorPageTouchPointVariant

Theme setErrorPageTouchPointVariant(ErrorPageTouchPointVariant errorPageTouchPointVariant)

getPrimaryColorContrastHex

String getPrimaryColorContrastHex()

setPrimaryColorContrastHex

Theme setPrimaryColorContrastHex(String primaryColorContrastHex)

getPrimaryColorHex

String getPrimaryColorHex()

setPrimaryColorHex

Theme setPrimaryColorHex(String primaryColorHex)

getSecondaryColorContrastHex

String getSecondaryColorContrastHex()

setSecondaryColorContrastHex

Theme setSecondaryColorContrastHex(String secondaryColorContrastHex)

getSecondaryColorHex

String getSecondaryColorHex()

setSecondaryColorHex

Theme setSecondaryColorHex(String secondaryColorHex)

getSignInPageTouchPointVariant

SignInPageTouchPointVariant getSignInPageTouchPointVariant()

setSignInPageTouchPointVariant

Theme setSignInPageTouchPointVariant(SignInPageTouchPointVariant signInPageTouchPointVariant)

deleteBrandThemeFavicon

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/brands/{brandId}/themes/{themeId}/favicon")
void deleteBrandThemeFavicon(String brandId,
                                                                                                                                                                                                                                      String themeId)

Deletes a Theme favicon. The org then uses the Okta default favicon. Deletes a Theme favicon. The org then uses the Okta default favicon.

Parameters:

brandId - (required)

themeId - (required)

deleteBrandThemeLogo

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/brands/{brandId}/themes/{themeId}/logo")
void deleteBrandThemeLogo(String brandId,
                                                                                                                                                                                                                                String themeId)

Deletes a Theme logo. The org then uses the Okta default logo. Deletes a Theme logo. The org then uses the Okta default logo.

Parameters:

brandId - (required)

themeId - (required)

deleteBrandThemeBackgroundImage

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="DELETE - /api/v1/brands/{brandId}/themes/{themeId}/background-image")
void deleteBrandThemeBackgroundImage(String brandId,
                                                                                                                                                                                                                                                       String themeId)

Deletes a Theme background image Deletes a Theme background image

Parameters:

brandId - (required)

themeId - (required)

updateBrandThemeFavicon

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/brands/{brandId}/themes/{themeId}/favicon")
ImageUploadResponse updateBrandThemeFavicon(String brandId,
                                                                                                                                                                                                                                                   String themeId,
                                                                                                                                                                                                                                                   File file)

Updates the favicon for your theme Updates the favicon for your theme

Parameters:

brandId - (required)

themeId - (required)

file - (required)

Returns:

ImageUploadResponse

uploadBrandThemeLogo

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/brands/{brandId}/themes/{themeId}/logo")
ImageUploadResponse uploadBrandThemeLogo(String brandId,
                                                                                                                                                                                                                                             String themeId,
                                                                                                                                                                                                                                             File file)

Update a themes logo Updates the logo for your Theme

Parameters:

brandId - (required)

themeId - (required)

file - (required)

Returns:

ImageUploadResponse

updateBrandThemeBackgroundImage

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="POST - /api/v1/brands/{brandId}/themes/{themeId}/background-image")
ImageUploadResponse updateBrandThemeBackgroundImage(String brandId,
                                                                                                                                                                                                                                                                    String themeId,
                                                                                                                                                                                                                                                                    File file)

Updates the background image for your Theme Updates the background image for your Theme

Parameters:

brandId - (required)

themeId - (required)

file - (required)

Returns:

ImageUploadResponse

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientApiCodegen",
           date="2023-07-07T09:07:50.516-05:00",
           comments="PUT - /api/v1/brands/{brandId}/themes/{themeId}")
ThemeResponse update(String brandId,
                                                                                                                                                                                                                   String themeId,
                                                                                                                                                                                                                   Theme theme)

Update a theme for a brand Updates a theme for a brand

Parameters:

brandId - (required)

themeId - (required)

theme - (required)

Returns:

ThemeResponse