Package com.okta.sdk.resource.api

Class UiSchemaApi

java.lang.Object
com.okta.sdk.resource.api.UiSchemaApi
@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 UiSchemaApi extends Object

  • Constructor Details

    • UiSchemaApi

      public UiSchemaApi()

    • UiSchemaApi

      public UiSchemaApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createUISchema

      public UISchemasResponseObject createUISchema(CreateUISchema uischemabody) throws ApiException
      Create a UI schema Creates an input for an enrollment form
      Parameters:
      uischemabody - (required)
      Returns:
      UISchemasResponseObject
      Throws:
      ApiException - if fails to make API call

    • createUISchema

      public UISchemasResponseObject createUISchema(CreateUISchema uischemabody, Map<String,String> additionalHeaders) throws ApiException
      Create a UI schema Creates an input for an enrollment form
      Parameters:
      uischemabody - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UISchemasResponseObject
      Throws:
      ApiException - if fails to make API call

    • deleteUISchemas

      public void deleteUISchemas(String id) throws ApiException
      Delete a UI schema Deletes a UI Schema by `id`
      Parameters:
      id - The unique ID of the UI Schema (required)
      Throws:
      ApiException - if fails to make API call

    • deleteUISchemas

      public void deleteUISchemas(String id, Map<String,String> additionalHeaders) throws ApiException
      Delete a UI schema Deletes a UI Schema by `id`
      Parameters:
      id - The unique ID of the UI Schema (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getUISchema

      public UISchemasResponseObject getUISchema(String id) throws ApiException
      Retrieve a UI schema Retrieves a UI Schema by `id`
      Parameters:
      id - The unique ID of the UI Schema (required)
      Returns:
      UISchemasResponseObject
      Throws:
      ApiException - if fails to make API call

    • getUISchema

      public UISchemasResponseObject getUISchema(String id, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a UI schema Retrieves a UI Schema by `id`
      Parameters:
      id - The unique ID of the UI Schema (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UISchemasResponseObject
      Throws:
      ApiException - if fails to make API call

    • listUISchemas

      public List<UISchemasResponseObject> listUISchemas() throws ApiException
      List all UI schemas Lists all UI Schemas in your org
      Returns:
      List<UISchemasResponseObject>
      Throws:
      ApiException - if fails to make API call

    • listUISchemas

      public List<UISchemasResponseObject> listUISchemas(Map<String,String> additionalHeaders) throws ApiException
      List all UI schemas Lists all UI Schemas in your org
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<UISchemasResponseObject>
      Throws:
      ApiException - if fails to make API call

    • listUISchemasPaged

      public Iterable<UISchemasResponseObject> listUISchemasPaged()
      List all UI schemas (Paginated) Lists all UI Schemas in your 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.
      Returns:
      Iterable<UISchemasResponseObject> lazy iterable over all pages

    • listUISchemasPaged

      public Iterable<UISchemasResponseObject> listUISchemasPaged(Map<String,String> additionalHeaders)
      List all UI schemas (Paginated with additional headers) Lists all UI Schemas in your org This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<UISchemasResponseObject> lazy iterable over all pages

    • replaceUISchemas

      public UISchemasResponseObject replaceUISchemas(String id, UpdateUISchema updateUISchemaBody) throws ApiException
      Replace a UI schema Replaces a UI Schema by `id`
      Parameters:
      id - The unique ID of the UI Schema (required)
      updateUISchemaBody - (required)
      Returns:
      UISchemasResponseObject
      Throws:
      ApiException - if fails to make API call

    • replaceUISchemas

      public UISchemasResponseObject replaceUISchemas(String id, UpdateUISchema updateUISchemaBody, Map<String,String> additionalHeaders) throws ApiException
      Replace a UI schema Replaces a UI Schema by `id`
      Parameters:
      id - The unique ID of the UI Schema (required)
      updateUISchemaBody - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UISchemasResponseObject
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

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