Package com.okta.sdk.resource.api

Class CustomPagesApi

java.lang.Object
com.okta.sdk.resource.api.CustomPagesApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]", comments="Generator version: 7.15.0") public class CustomPagesApi extends Object

  • Constructor Details

    • CustomPagesApi

      public CustomPagesApi()

    • CustomPagesApi

      public CustomPagesApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • 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

    • 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

    • 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

    • 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

    • listAllSignInWidgetVersionsPaged

      public Iterable<String> listAllSignInWidgetVersionsPaged(String brandId)
      List all Sign-In Widget versions (Paginated) Lists all sign-in widget versions supported by the current org This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      brandId - The ID of the brand (required)
      Returns:
      Iterable<String> lazy iterable over all pages

    • listAllSignInWidgetVersionsPaged

      public Iterable<String> listAllSignInWidgetVersionsPaged(String brandId, Map<String,String> additionalHeaders)
      List all Sign-In Widget versions (Paginated with additional headers) Lists all sign-in widget versions supported by the current org This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      brandId - The ID of the brand (required)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<String> lazy iterable over all pages

    • 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

    • 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

    • getObjectMapper

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