Package com.okta.sdk.resource.api

Class ThemesApi

java.lang.Object

com.okta.sdk.resource.api.ThemesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T08:35:59.300824-05:00[America/Chicago]",
           comments="Generator version: 7.8.0")
public class ThemesApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ThemesApi()
ThemesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	deleteBrandThemeBackgroundImage(String brandId, String themeId)	Delete the Background Image Deletes a Theme background image
void	deleteBrandThemeBackgroundImage(String brandId, String themeId, Map<String,String> additionalHeaders)	Delete the Background Image Deletes a Theme background image
void	deleteBrandThemeFavicon(String brandId, String themeId)	Delete the Favicon Deletes a Theme favicon.
void	deleteBrandThemeFavicon(String brandId, String themeId, Map<String,String> additionalHeaders)	Delete the Favicon Deletes a Theme favicon.
void	deleteBrandThemeLogo(String brandId, String themeId)	Delete the Logo Deletes a Theme logo.
void	deleteBrandThemeLogo(String brandId, String themeId, Map<String,String> additionalHeaders)	Delete the Logo Deletes a Theme logo.
ApiClient	getApiClient()
ThemeResponse	getBrandTheme(String brandId, String themeId)	Retrieve a Theme Retrieves a theme for a brand
ThemeResponse	getBrandTheme(String brandId, String themeId, Map<String,String> additionalHeaders)	Retrieve a Theme Retrieves a theme for a brand
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<ThemeResponse>	listBrandThemes(String brandId)	List all Themes Lists all the themes in your brand.
List<ThemeResponse>	listBrandThemes(String brandId, Map<String,String> additionalHeaders)	List all Themes Lists all the themes in your brand.
ThemeResponse	replaceBrandTheme(String brandId, String themeId, UpdateThemeRequest theme)	Replace a Theme Replaces a theme for a brand
ThemeResponse	replaceBrandTheme(String brandId, String themeId, UpdateThemeRequest theme, Map<String,String> additionalHeaders)	Replace a Theme Replaces a theme for a brand
void	setApiClient(ApiClient apiClient)
ImageUploadResponse	uploadBrandThemeBackgroundImage(String brandId, String themeId, File _file)	Upload the Background Image Uploads and replaces the background image for the theme.
ImageUploadResponse	uploadBrandThemeBackgroundImage(String brandId, String themeId, File _file, Map<String,String> additionalHeaders)	Upload the Background Image Uploads and replaces the background image for the theme.
ImageUploadResponse	uploadBrandThemeFavicon(String brandId, String themeId, File _file)	Upload the Favicon Uploads and replaces the favicon for the theme
ImageUploadResponse	uploadBrandThemeFavicon(String brandId, String themeId, File _file, Map<String,String> additionalHeaders)	Upload the Favicon Uploads and replaces the favicon for the theme
ImageUploadResponse	uploadBrandThemeLogo(String brandId, String themeId, File _file)	Upload the Logo Uploads and replaces the logo for the theme.
ImageUploadResponse	uploadBrandThemeLogo(String brandId, String themeId, File _file, Map<String,String> additionalHeaders)	Upload the Logo Uploads and replaces the logo for the theme.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ThemesApi

public ThemesApi()

ThemesApi

public ThemesApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteBrandThemeBackgroundImage

public void deleteBrandThemeBackgroundImage(String brandId,
 String themeId)
                                     throws ApiException

Delete the Background Image Deletes a Theme background image

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

Throws:

ApiException - if fails to make API call

deleteBrandThemeBackgroundImage

public void deleteBrandThemeBackgroundImage(String brandId,
 String themeId,
 Map<String,String> additionalHeaders)
                                     throws ApiException

Delete the Background Image Deletes a Theme background image

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteBrandThemeFavicon

public void deleteBrandThemeFavicon(String brandId,
 String themeId)
                             throws ApiException

Delete the Favicon Deletes a Theme favicon. The theme will use the default Okta favicon.

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

Throws:

ApiException - if fails to make API call

deleteBrandThemeFavicon

public void deleteBrandThemeFavicon(String brandId,
 String themeId,
 Map<String,String> additionalHeaders)
                             throws ApiException

Delete the Favicon Deletes a Theme favicon. The theme will use the default Okta favicon.

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteBrandThemeLogo

public void deleteBrandThemeLogo(String brandId,
 String themeId)
                          throws ApiException

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

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

Throws:

ApiException - if fails to make API call

deleteBrandThemeLogo

public void deleteBrandThemeLogo(String brandId,
 String themeId,
 Map<String,String> additionalHeaders)
                          throws ApiException

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

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getBrandTheme

public ThemeResponse getBrandTheme(String brandId,
 String themeId)
                            throws ApiException

Retrieve a Theme Retrieves a theme for a brand

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

Returns:

ThemeResponse

Throws:

ApiException - if fails to make API call

getBrandTheme

public ThemeResponse getBrandTheme(String brandId,
 String themeId,
 Map<String,String> additionalHeaders)
                            throws ApiException

Retrieve a Theme Retrieves a theme for a brand

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

additionalHeaders - additionalHeaders for this call

Returns:

ThemeResponse

Throws:

ApiException - if fails to make API call

listBrandThemes

public List<ThemeResponse> listBrandThemes(String brandId)
                                    throws ApiException

List all Themes Lists all the themes in your brand. > **Important:** Currently each org supports only one Theme, therefore this contains a single object only.

Parameters:

brandId - The ID of the brand (required)

Returns:

List<ThemeResponse>

Throws:

ApiException - if fails to make API call

listBrandThemes

public List<ThemeResponse> listBrandThemes(String brandId,
 Map<String,String> additionalHeaders)
                                    throws ApiException

List all Themes Lists all the themes in your brand. > **Important:** Currently each org supports only one Theme, therefore this contains a single object only.

Parameters:

brandId - The ID of the brand (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<ThemeResponse>

Throws:

ApiException - if fails to make API call

replaceBrandTheme

public ThemeResponse replaceBrandTheme(String brandId,
 String themeId,
 UpdateThemeRequest theme)
                                throws ApiException

Replace a Theme Replaces a theme for a brand

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

theme - (required)

Returns:

ThemeResponse

Throws:

ApiException - if fails to make API call

replaceBrandTheme

public ThemeResponse replaceBrandTheme(String brandId,
 String themeId,
 UpdateThemeRequest theme,
 Map<String,String> additionalHeaders)
                                throws ApiException

Replace a Theme Replaces a theme for a brand

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

theme - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ThemeResponse

Throws:

ApiException - if fails to make API call

uploadBrandThemeBackgroundImage

public ImageUploadResponse uploadBrandThemeBackgroundImage(String brandId,
 String themeId,
 File _file)
                                                    throws ApiException

Upload the 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.

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

_file - (required)

Returns:

ImageUploadResponse

Throws:

ApiException - if fails to make API call

uploadBrandThemeBackgroundImage

public ImageUploadResponse uploadBrandThemeBackgroundImage(String brandId,
 String themeId,
 File _file,
 Map<String,String> additionalHeaders)
                                                    throws ApiException

Upload the 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.

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

_file - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ImageUploadResponse

Throws:

ApiException - if fails to make API call

uploadBrandThemeFavicon

public ImageUploadResponse uploadBrandThemeFavicon(String brandId,
 String themeId,
 File _file)
                                            throws ApiException

Upload the Favicon Uploads and replaces the favicon for the theme

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

_file - (required)

Returns:

ImageUploadResponse

Throws:

ApiException - if fails to make API call

uploadBrandThemeFavicon

public ImageUploadResponse uploadBrandThemeFavicon(String brandId,
 String themeId,
 File _file,
 Map<String,String> additionalHeaders)
                                            throws ApiException

Upload the Favicon Uploads and replaces the favicon for the theme

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

_file - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ImageUploadResponse

Throws:

ApiException - if fails to make API call

uploadBrandThemeLogo

public ImageUploadResponse uploadBrandThemeLogo(String brandId,
 String themeId,
 File _file)
                                         throws ApiException

Upload the 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.

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

_file - (required)

Returns:

ImageUploadResponse

Throws:

ApiException - if fails to make API call

uploadBrandThemeLogo

public ImageUploadResponse uploadBrandThemeLogo(String brandId,
 String themeId,
 File _file,
 Map<String,String> additionalHeaders)
                                         throws ApiException

Upload the 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.

Parameters:

brandId - The ID of the brand (required)

themeId - The ID of the theme (required)

_file - (required)

additionalHeaders - additionalHeaders for this call

Returns:

ImageUploadResponse

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()