Class EmailDomainApi

java.lang.Object
com.okta.sdk.resource.api.EmailDomainApi

@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 EmailDomainApi extends Object
  • Constructor Details

    • EmailDomainApi

      public EmailDomainApi()
    • EmailDomainApi

      public EmailDomainApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • createEmailDomain

      public EmailDomainResponse createEmailDomain(EmailDomain emailDomain, List<String> expand) throws ApiException
      Create an email domain Creates an Email Domain in your org
      Parameters:
      emailDomain - (required)
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      EmailDomainResponse
      Throws:
      ApiException - if fails to make API call
    • createEmailDomain

      public EmailDomainResponse createEmailDomain(EmailDomain emailDomain, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      Create an email domain Creates an Email Domain in your org
      Parameters:
      emailDomain - (required)
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailDomainResponse
      Throws:
      ApiException - if fails to make API call
    • deleteEmailDomain

      public void deleteEmailDomain(String emailDomainId, List<String> expand) throws ApiException
      Delete an email domain Deletes an Email Domain by `emailDomainId`
      Parameters:
      emailDomainId - (required)
      expand - Specifies additional metadata to be included in the response (optional
      Throws:
      ApiException - if fails to make API call
    • deleteEmailDomain

      public void deleteEmailDomain(String emailDomainId, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      Delete an email domain Deletes an Email Domain by `emailDomainId`
      Parameters:
      emailDomainId - (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
    • getEmailDomain

      public EmailDomainResponseWithEmbedded getEmailDomain(String emailDomainId, List<String> expand) throws ApiException
      Retrieve an email domain Retrieves an Email Domain by `emailDomainId`
      Parameters:
      emailDomainId - (required)
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      EmailDomainResponseWithEmbedded
      Throws:
      ApiException - if fails to make API call
    • getEmailDomain

      public EmailDomainResponseWithEmbedded getEmailDomain(String emailDomainId, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an email domain Retrieves an Email Domain by `emailDomainId`
      Parameters:
      emailDomainId - (required)
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailDomainResponseWithEmbedded
      Throws:
      ApiException - if fails to make API call
    • listEmailDomains

      public List<EmailDomainResponseWithEmbedded> listEmailDomains(List<String> expand) throws ApiException
      List all email domains Lists all the Email Domains in your org
      Parameters:
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      List<EmailDomainResponseWithEmbedded>
      Throws:
      ApiException - if fails to make API call
    • listEmailDomains

      public List<EmailDomainResponseWithEmbedded> listEmailDomains(List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      List all email domains Lists all the Email Domains in your org
      Parameters:
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<EmailDomainResponseWithEmbedded>
      Throws:
      ApiException - if fails to make API call
    • listEmailDomainsPaged

      public Iterable<EmailDomainResponseWithEmbedded> listEmailDomainsPaged(List<String> expand)
      List all email domains (Paginated) Lists all the Email Domains 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.
      Parameters:
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      Iterable<EmailDomainResponseWithEmbedded> lazy iterable over all pages
    • listEmailDomainsPaged

      public Iterable<EmailDomainResponseWithEmbedded> listEmailDomainsPaged(List<String> expand, Map<String,String> additionalHeaders)
      List all email domains (Paginated with additional headers) Lists all the Email Domains 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:
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<EmailDomainResponseWithEmbedded> lazy iterable over all pages
    • replaceEmailDomain

      public EmailDomainResponse replaceEmailDomain(String emailDomainId, UpdateEmailDomain updateEmailDomain, List<String> expand) throws ApiException
      Replace an email domain Replaces associated username and sender display name by `emailDomainId`
      Parameters:
      emailDomainId - (required)
      updateEmailDomain - (required)
      expand - Specifies additional metadata to be included in the response (optional
      Returns:
      EmailDomainResponse
      Throws:
      ApiException - if fails to make API call
    • replaceEmailDomain

      public EmailDomainResponse replaceEmailDomain(String emailDomainId, UpdateEmailDomain updateEmailDomain, List<String> expand, Map<String,String> additionalHeaders) throws ApiException
      Replace an email domain Replaces associated username and sender display name by `emailDomainId`
      Parameters:
      emailDomainId - (required)
      updateEmailDomain - (required)
      expand - Specifies additional metadata to be included in the response (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailDomainResponse
      Throws:
      ApiException - if fails to make API call
    • verifyEmailDomain

      public EmailDomainResponse verifyEmailDomain(String emailDomainId) throws ApiException
      Verify an email domain Verifies an Email Domain by `emailDomainId`
      Parameters:
      emailDomainId - (required)
      Returns:
      EmailDomainResponse
      Throws:
      ApiException - if fails to make API call
    • verifyEmailDomain

      public EmailDomainResponse verifyEmailDomain(String emailDomainId, Map<String,String> additionalHeaders) throws ApiException
      Verify an email domain Verifies an Email Domain by `emailDomainId`
      Parameters:
      emailDomainId - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      EmailDomainResponse
      Throws:
      ApiException - if fails to make API call
    • getObjectMapper

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