Package com.okta.sdk.resource.api

Class CustomizationApi

java.lang.Object
com.okta.sdk.resource.api.CustomizationApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-17T07:49:15.347219-05:00[America/Chicago]", comments="Generator version: 7.5.0") public class CustomizationApi extends Object

  • Constructor Details

    • CustomizationApi

      public CustomizationApi()

    • CustomizationApi

      public CustomizationApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createBrand

      public Brand createBrand(List<String> expand, String after, Integer limit, String q, CreateBrandRequest createBrandRequest) throws ApiException
      Create a Brand Creates a new brand in your org
      Parameters:
      expand - Specifies additional metadata to be included in the response (optional
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      q - Searches the records for matching value (optional)
      createBrandRequest - (optional)
      Returns:
      Brand
      Throws:
      ApiException - if fails to make API call

    • createBrand

      public Brand createBrand(List<String> expand, String after, Integer limit, String q, CreateBrandRequest createBrandRequest, Map<String,String> additionalHeaders) throws ApiException
      Create a Brand Creates a new brand in your org
      Parameters:
      expand - Specifies additional metadata to be included in the response (optional
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      q - Searches the records for matching value (optional)
      createBrandRequest - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Brand
      Throws:
      ApiException - if fails to make API call

    • createEmailCustomization

      public EmailCustomization createEmailCustomization(String brandId, String templateName, EmailCustomization instance) throws ApiException
      Create an Email Customization Creates a new email customization
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      instance - (optional)
      Returns:
      EmailCustomization
      Throws:
      ApiException - if fails to make API call

    • createEmailCustomization

      public EmailCustomization createEmailCustomization(String brandId, String templateName, EmailCustomization instance, Map<String,String> additionalHeaders) throws ApiException
      Create an Email Customization Creates a new email customization
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      instance - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailCustomization
      Throws:
      ApiException - if fails to make API call

    • deleteAllCustomizations

      public void deleteAllCustomizations(String brandId, String templateName) throws ApiException
      Delete all Email Customizations Deletes all customizations for an email template
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      Throws:
      ApiException - if fails to make API call

    • deleteAllCustomizations

      public void deleteAllCustomizations(String brandId, String templateName, Map<String,String> additionalHeaders) throws ApiException
      Delete all Email Customizations Deletes all customizations for an email template
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteBrand

      public void deleteBrand(String brandId, List<String> expand) throws ApiException
      Delete a brand Deletes a brand by `brandId`
      Parameters:
      brandId - The ID of the brand (required)
      expand - Specifies additional metadata to be included in the response (optional
      Throws:
      ApiException - if fails to make API call

    • deleteBrand

      public void deleteBrand(String brandId, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      Delete a brand Deletes a brand by `brandId`
      Parameters:
      brandId - The ID of the brand (required)
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • 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

    • deleteCustomizedErrorPage

      public void deleteCustomizedErrorPage(String brandId) throws ApiException
      Delete the Customized Error Page Deletes the customized error page. As a result, the default error page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      Throws:
      ApiException - if fails to make API call

    • deleteCustomizedErrorPage

      public void deleteCustomizedErrorPage(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Delete the Customized Error Page Deletes the customized error page. As a result, the default error page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteCustomizedSignInPage

      public void deleteCustomizedSignInPage(String brandId) throws ApiException
      Delete the Customized Sign-in Page Deletes the customized sign-in page. As a result, the default sign-in page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      Throws:
      ApiException - if fails to make API call

    • deleteCustomizedSignInPage

      public void deleteCustomizedSignInPage(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Delete the Customized Sign-in Page Deletes the customized sign-in page. As a result, the default sign-in page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteEmailCustomization

      public void deleteEmailCustomization(String brandId, String templateName, String customizationId) throws ApiException
      Delete an Email Customization Deletes an email customization by its unique identifier
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      customizationId - The ID of the email customization (required)
      Throws:
      ApiException - if fails to make API call

    • deleteEmailCustomization

      public void deleteEmailCustomization(String brandId, String templateName, String customizationId, Map<String,String> additionalHeaders) throws ApiException
      Delete an Email Customization Deletes an email customization by its unique identifier
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      customizationId - The ID of the email customization (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deletePreviewErrorPage

      public void deletePreviewErrorPage(String brandId) throws ApiException
      Delete the Preview Error Page Deletes the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      Throws:
      ApiException - if fails to make API call

    • deletePreviewErrorPage

      public void deletePreviewErrorPage(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Delete the Preview Error Page Deletes the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deletePreviewSignInPage

      public void deletePreviewSignInPage(String brandId) throws ApiException
      Delete the Preview Sign-in Page Deletes the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      Throws:
      ApiException - if fails to make API call

    • deletePreviewSignInPage

      public void deletePreviewSignInPage(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Delete the Preview Sign-in Page Deletes the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getBrand

      public BrandWithEmbedded getBrand(String brandId, List<String> expand) throws ApiException
      Retrieve a Brand Retrieves a brand by `brandId`
      Parameters:
      brandId - The ID of the brand (required)
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      BrandWithEmbedded
      Throws:
      ApiException - if fails to make API call

    • getBrand

      public BrandWithEmbedded getBrand(String brandId, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a Brand Retrieves a brand by `brandId`
      Parameters:
      brandId - The ID of the brand (required)
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      BrandWithEmbedded
      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

    • getCustomizationPreview

      public EmailPreview getCustomizationPreview(String brandId, String templateName, String customizationId) throws ApiException
      Retrieve a Preview of an Email Customization Retrieves a preview of an email customization. All variable references (e.g., `${user.profile.firstName}`) are populated using the current user's context.
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      customizationId - The ID of the email customization (required)
      Returns:
      EmailPreview
      Throws:
      ApiException - if fails to make API call

    • getCustomizationPreview

      public EmailPreview getCustomizationPreview(String brandId, String templateName, String customizationId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a Preview of an Email Customization Retrieves a preview of an email customization. All variable references (e.g., `${user.profile.firstName}`) are populated using the current user's context.
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      customizationId - The ID of the email customization (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailPreview
      Throws:
      ApiException - if fails to make API call

    • getCustomizedErrorPage

      public ErrorPage getCustomizedErrorPage(String brandId) throws ApiException
      Retrieve the Customized Error Page Retrieves the customized error page. The customized error page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      Returns:
      ErrorPage
      Throws:
      ApiException - if fails to make API call

    • getCustomizedErrorPage

      public ErrorPage getCustomizedErrorPage(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Customized Error Page Retrieves the customized error page. The customized error page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ErrorPage
      Throws:
      ApiException - if fails to make API call

    • getCustomizedSignInPage

      public SignInPage getCustomizedSignInPage(String brandId) throws ApiException
      Retrieve the Customized Sign-in Page Retrieves the customized sign-in page. The customized sign-in page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      Returns:
      SignInPage
      Throws:
      ApiException - if fails to make API call

    • getCustomizedSignInPage

      public SignInPage getCustomizedSignInPage(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Customized Sign-in Page Retrieves the customized sign-in page. The customized sign-in page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      SignInPage
      Throws:
      ApiException - if fails to make API call

    • getDefaultErrorPage

      public ErrorPage getDefaultErrorPage(String brandId) throws ApiException
      Retrieve the Default Error Page Retrieves the default error page. The default error page appears when no customized error page exists.
      Parameters:
      brandId - The ID of the brand (required)
      Returns:
      ErrorPage
      Throws:
      ApiException - if fails to make API call

    • getDefaultErrorPage

      public ErrorPage getDefaultErrorPage(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Default Error Page Retrieves the default error page. The default error page appears when no customized error page exists.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ErrorPage
      Throws:
      ApiException - if fails to make API call

    • getDefaultSignInPage

      public SignInPage getDefaultSignInPage(String brandId) throws ApiException
      Retrieve the Default Sign-in Page Retrieves the default sign-in page. The default sign-in page appears when no customized sign-in page exists.
      Parameters:
      brandId - The ID of the brand (required)
      Returns:
      SignInPage
      Throws:
      ApiException - if fails to make API call

    • getDefaultSignInPage

      public SignInPage getDefaultSignInPage(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Default Sign-in Page Retrieves the default sign-in page. The default sign-in page appears when no customized sign-in page exists.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      SignInPage
      Throws:
      ApiException - if fails to make API call

    • getEmailCustomization

      public EmailCustomization getEmailCustomization(String brandId, String templateName, String customizationId) throws ApiException
      Retrieve an Email Customization Retrieves an email customization by its unique identifier
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      customizationId - The ID of the email customization (required)
      Returns:
      EmailCustomization
      Throws:
      ApiException - if fails to make API call

    • getEmailCustomization

      public EmailCustomization getEmailCustomization(String brandId, String templateName, String customizationId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an Email Customization Retrieves an email customization by its unique identifier
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      customizationId - The ID of the email customization (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailCustomization
      Throws:
      ApiException - if fails to make API call

    • getEmailDefaultContent

      public EmailDefaultContent getEmailDefaultContent(String brandId, String templateName, String language) throws ApiException
      Retrieve an Email Template Default Content Retrieves an email template's default content
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
      Returns:
      EmailDefaultContent
      Throws:
      ApiException - if fails to make API call

    • getEmailDefaultContent

      public EmailDefaultContent getEmailDefaultContent(String brandId, String templateName, String language, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an Email Template Default Content Retrieves an email template's default content
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailDefaultContent
      Throws:
      ApiException - if fails to make API call

    • getEmailDefaultPreview

      public EmailPreview getEmailDefaultPreview(String brandId, String templateName, String language) throws ApiException
      Retrieve a Preview of the Email Template Default Content Retrieves a preview of an email template's default content. All variable references (e.g., `${user.profile.firstName}`) are populated using the current user's context.
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
      Returns:
      EmailPreview
      Throws:
      ApiException - if fails to make API call

    • getEmailDefaultPreview

      public EmailPreview getEmailDefaultPreview(String brandId, String templateName, String language, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a Preview of the Email Template Default Content Retrieves a preview of an email template's default content. All variable references (e.g., `${user.profile.firstName}`) are populated using the current user's context.
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailPreview
      Throws:
      ApiException - if fails to make API call

    • getEmailSettings

      public EmailSettings getEmailSettings(String brandId, String templateName) throws ApiException
      Retrieve the Email Template Settings Retrieves an email template's settings
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      Returns:
      EmailSettings
      Throws:
      ApiException - if fails to make API call

    • getEmailSettings

      public EmailSettings getEmailSettings(String brandId, String templateName, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Email Template Settings Retrieves an email template's settings
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailSettings
      Throws:
      ApiException - if fails to make API call

    • getEmailTemplate

      public EmailTemplate getEmailTemplate(String brandId, String templateName, List<String> expand) throws ApiException
      Retrieve an Email Template Retrieves the details of an email template by name
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      EmailTemplate
      Throws:
      ApiException - if fails to make API call

    • getEmailTemplate

      public EmailTemplate getEmailTemplate(String brandId, String templateName, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an Email Template Retrieves the details of an email template by name
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailTemplate
      Throws:
      ApiException - if fails to make API call

    • getErrorPage

      public PageRoot getErrorPage(String brandId, List<String> expand) throws ApiException
      Retrieve the Error Page Sub-Resources Retrieves the error page sub-resources. The `expand` query parameter specifies which sub-resources to include in the response.
      Parameters:
      brandId - The ID of the brand (required)
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      PageRoot
      Throws:
      ApiException - if fails to make API call

    • getErrorPage

      public PageRoot getErrorPage(String brandId, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Error Page Sub-Resources Retrieves the error page sub-resources. The `expand` query parameter specifies which sub-resources to include in the response.
      Parameters:
      brandId - The ID of the brand (required)
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      PageRoot
      Throws:
      ApiException - if fails to make API call

    • getPreviewErrorPage

      public ErrorPage getPreviewErrorPage(String brandId) throws ApiException
      Retrieve the Preview Error Page Preview Retrieves the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      Returns:
      ErrorPage
      Throws:
      ApiException - if fails to make API call

    • getPreviewErrorPage

      public ErrorPage getPreviewErrorPage(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Preview Error Page Preview Retrieves the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ErrorPage
      Throws:
      ApiException - if fails to make API call

    • getPreviewSignInPage

      public SignInPage getPreviewSignInPage(String brandId) throws ApiException
      Retrieve the Preview Sign-in Page Preview Retrieves the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      Returns:
      SignInPage
      Throws:
      ApiException - if fails to make API call

    • getPreviewSignInPage

      public SignInPage getPreviewSignInPage(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Preview Sign-in Page Preview Retrieves the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      SignInPage
      Throws:
      ApiException - if fails to make API call

    • getSignInPage

      public PageRoot getSignInPage(String brandId, List<String> expand) throws ApiException
      Retrieve the Sign-in Page Sub-Resources Retrieves the sign-in page sub-resources. The `expand` query parameter specifies which sub-resources to include in the response.
      Parameters:
      brandId - The ID of the brand (required)
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      PageRoot
      Throws:
      ApiException - if fails to make API call

    • getSignInPage

      public PageRoot getSignInPage(String brandId, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Sign-in Page Sub-Resources Retrieves the sign-in page sub-resources. The `expand` query parameter specifies which sub-resources to include in the response.
      Parameters:
      brandId - The ID of the brand (required)
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      PageRoot
      Throws:
      ApiException - if fails to make API call

    • getSignOutPageSettings

      public HostedPage getSignOutPageSettings(String brandId) throws ApiException
      Retrieve the Sign-out Page Settings Retrieves the sign-out page settings
      Parameters:
      brandId - The ID of the brand (required)
      Returns:
      HostedPage
      Throws:
      ApiException - if fails to make API call

    • getSignOutPageSettings

      public HostedPage getSignOutPageSettings(String brandId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the Sign-out Page Settings Retrieves the sign-out page settings
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HostedPage
      Throws:
      ApiException - if fails to make API call

    • listAllSignInWidgetVersions

      public List<String> listAllSignInWidgetVersions(String brandId) throws ApiException
      List all Sign-in Widget Versions Lists all sign-in widget versions supported by the current org
      Parameters:
      brandId - The ID of the brand (required)
      Returns:
      List<String>
      Throws:
      ApiException - if fails to make API call

    • listAllSignInWidgetVersions

      public List<String> listAllSignInWidgetVersions(String brandId, Map<String,String> additionalHeaders) throws ApiException
      List all Sign-in Widget Versions Lists all sign-in widget versions supported by the current org
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<String>
      Throws:
      ApiException - if fails to make API call

    • listBrandDomains

      public List<DomainResponse> listBrandDomains(String brandId) throws ApiException
      List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`
      Parameters:
      brandId - The ID of the brand (required)
      Returns:
      List<DomainResponse>
      Throws:
      ApiException - if fails to make API call

    • listBrandDomains

      public List<DomainResponse> listBrandDomains(String brandId, Map<String,String> additionalHeaders) throws ApiException
      List all Domains associated with a Brand Lists all domains associated with a brand by `brandId`
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<DomainResponse>
      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
      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
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<ThemeResponse>
      Throws:
      ApiException - if fails to make API call

    • listBrands

      public List<BrandWithEmbedded> listBrands(List<String> expand, String after, Integer limit, String q) throws ApiException
      List all Brands Lists all the brands in your org
      Parameters:
      expand - Specifies additional metadata to be included in the response (optional
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      q - Searches the records for matching value (optional)
      Returns:
      List<BrandWithEmbedded>
      Throws:
      ApiException - if fails to make API call

    • listBrands

      public List<BrandWithEmbedded> listBrands(List<String> expand, String after, Integer limit, String q, Map<String,String> additionalHeaders) throws ApiException
      List all Brands Lists all the brands in your org
      Parameters:
      expand - Specifies additional metadata to be included in the response (optional
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      q - Searches the records for matching value (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<BrandWithEmbedded>
      Throws:
      ApiException - if fails to make API call

    • listEmailCustomizations

      public List<EmailCustomization> listEmailCustomizations(String brandId, String templateName, String after, Integer limit) throws ApiException
      List all Email Customizations Lists all customizations of an email template
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      Returns:
      List<EmailCustomization>
      Throws:
      ApiException - if fails to make API call

    • listEmailCustomizations

      public List<EmailCustomization> listEmailCustomizations(String brandId, String templateName, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all Email Customizations Lists all customizations of an email template
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<EmailCustomization>
      Throws:
      ApiException - if fails to make API call

    • listEmailTemplates

      public List<EmailTemplate> listEmailTemplates(String brandId, String after, Integer limit, List<String> expand) throws ApiException
      List all Email Templates Lists all email templates
      Parameters:
      brandId - The ID of the brand (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      List<EmailTemplate>
      Throws:
      ApiException - if fails to make API call

    • listEmailTemplates

      public List<EmailTemplate> listEmailTemplates(String brandId, String after, Integer limit, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      List all Email Templates Lists all email templates
      Parameters:
      brandId - The ID of the brand (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<EmailTemplate>
      Throws:
      ApiException - if fails to make API call

    • replaceBrand

      public Brand replaceBrand(String brandId, BrandRequest brand, List<String> expand) throws ApiException
      Replace a Brand Replaces a brand by `brandId`
      Parameters:
      brandId - The ID of the brand (required)
      brand - (required)
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      Brand
      Throws:
      ApiException - if fails to make API call

    • replaceBrand

      public Brand replaceBrand(String brandId, BrandRequest brand, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      Replace a Brand Replaces a brand by `brandId`
      Parameters:
      brandId - The ID of the brand (required)
      brand - (required)
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      Brand
      Throws:
      ApiException - if fails to make API call

    • replaceBrandTheme

      public ThemeResponse replaceBrandTheme(String brandId, String themeId, Theme 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, Theme 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

    • replaceCustomizedErrorPage

      public ErrorPage replaceCustomizedErrorPage(String brandId, ErrorPage errorPage) throws ApiException
      Replace the Customized Error Page Replaces the customized error page. The customized error page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      errorPage - (required)
      Returns:
      ErrorPage
      Throws:
      ApiException - if fails to make API call

    • replaceCustomizedErrorPage

      public ErrorPage replaceCustomizedErrorPage(String brandId, ErrorPage errorPage, Map<String,String> additionalHeaders) throws ApiException
      Replace the Customized Error Page Replaces the customized error page. The customized error page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      errorPage - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ErrorPage
      Throws:
      ApiException - if fails to make API call

    • replaceCustomizedSignInPage

      public SignInPage replaceCustomizedSignInPage(String brandId, SignInPage signInPage) throws ApiException
      Replace the Customized Sign-in Page Replaces the customized sign-in page. The customized sign-in page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      signInPage - (required)
      Returns:
      SignInPage
      Throws:
      ApiException - if fails to make API call

    • replaceCustomizedSignInPage

      public SignInPage replaceCustomizedSignInPage(String brandId, SignInPage signInPage, Map<String,String> additionalHeaders) throws ApiException
      Replace the Customized Sign-in Page Replaces the customized sign-in page. The customized sign-in page appears in your live environment.
      Parameters:
      brandId - The ID of the brand (required)
      signInPage - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      SignInPage
      Throws:
      ApiException - if fails to make API call

    • replaceEmailCustomization

      public EmailCustomization replaceEmailCustomization(String brandId, String templateName, String customizationId, EmailCustomization instance) throws ApiException
      Replace an Email Customization Replaces an existing email customization using the property values provided
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      customizationId - The ID of the email customization (required)
      instance - Request (optional)
      Returns:
      EmailCustomization
      Throws:
      ApiException - if fails to make API call

    • replaceEmailCustomization

      public EmailCustomization replaceEmailCustomization(String brandId, String templateName, String customizationId, EmailCustomization instance, Map<String,String> additionalHeaders) throws ApiException
      Replace an Email Customization Replaces an existing email customization using the property values provided
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      customizationId - The ID of the email customization (required)
      instance - Request (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailCustomization
      Throws:
      ApiException - if fails to make API call

    • replaceEmailSettings

      public void replaceEmailSettings(String brandId, String templateName, EmailSettings emailSettings) throws ApiException
      Replace the Email Template Settings Replaces an email template's settings
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      emailSettings - (optional)
      Throws:
      ApiException - if fails to make API call

    • replaceEmailSettings

      public void replaceEmailSettings(String brandId, String templateName, EmailSettings emailSettings, Map<String,String> additionalHeaders) throws ApiException
      Replace the Email Template Settings Replaces an email template's settings
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      emailSettings - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • replacePreviewErrorPage

      public ErrorPage replacePreviewErrorPage(String brandId, ErrorPage errorPage) throws ApiException
      Replace the Preview Error Page Replaces the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      errorPage - (required)
      Returns:
      ErrorPage
      Throws:
      ApiException - if fails to make API call

    • replacePreviewErrorPage

      public ErrorPage replacePreviewErrorPage(String brandId, ErrorPage errorPage, Map<String,String> additionalHeaders) throws ApiException
      Replace the Preview Error Page Replaces the preview error page. The preview error page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/error/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      errorPage - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ErrorPage
      Throws:
      ApiException - if fails to make API call

    • replacePreviewSignInPage

      public SignInPage replacePreviewSignInPage(String brandId, SignInPage signInPage) throws ApiException
      Replace the Preview Sign-in Page Replaces the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      signInPage - (required)
      Returns:
      SignInPage
      Throws:
      ApiException - if fails to make API call

    • replacePreviewSignInPage

      public SignInPage replacePreviewSignInPage(String brandId, SignInPage signInPage, Map<String,String> additionalHeaders) throws ApiException
      Replace the Preview Sign-in Page Replaces the preview sign-in page. The preview sign-in page contains unpublished changes and isn't shown in your live environment. Preview it at `${yourOktaDomain}/login/preview`.
      Parameters:
      brandId - The ID of the brand (required)
      signInPage - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      SignInPage
      Throws:
      ApiException - if fails to make API call

    • replaceSignOutPageSettings

      public HostedPage replaceSignOutPageSettings(String brandId, HostedPage hostedPage) throws ApiException
      Replace the Sign-out Page Settings Replaces the sign-out page settings
      Parameters:
      brandId - The ID of the brand (required)
      hostedPage - (required)
      Returns:
      HostedPage
      Throws:
      ApiException - if fails to make API call

    • replaceSignOutPageSettings

      public HostedPage replaceSignOutPageSettings(String brandId, HostedPage hostedPage, Map<String,String> additionalHeaders) throws ApiException
      Replace the Sign-out Page Settings Replaces the sign-out page settings
      Parameters:
      brandId - The ID of the brand (required)
      hostedPage - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HostedPage
      Throws:
      ApiException - if fails to make API call

    • sendTestEmail

      public void sendTestEmail(String brandId, String templateName, String language) throws ApiException
      Send a Test Email Sends a test email to the current user’s primary and secondary email addresses. The email content is selected based on the following priority: 1. The email customization for the language specified in the `language` query parameter. 2. The email template's default customization. 3. The email template’s default content, translated to the current user's language.
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
      Throws:
      ApiException - if fails to make API call

    • sendTestEmail

      public void sendTestEmail(String brandId, String templateName, String language, Map<String,String> additionalHeaders) throws ApiException
      Send a Test Email Sends a test email to the current user’s primary and secondary email addresses. The email content is selected based on the following priority: 1. The email customization for the language specified in the `language` query parameter. 2. The email template's default customization. 3. The email template’s default content, translated to the current user's language.
      Parameters:
      brandId - The ID of the brand (required)
      templateName - The name of the email template (required)
      language - The language to use for the email. Defaults to the current user's language if unspecified. (optional)
      additionalHeaders - additionalHeaders for this call
      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()