Package com.okta.sdk.resource.api

Class PushProviderApi

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

  • Constructor Details

    • PushProviderApi

      public PushProviderApi()

    • PushProviderApi

      public PushProviderApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createPushProvider

      public PushProvider createPushProvider(PushProvider pushProvider) throws ApiException
      Create a push provider Creates a new push provider. Each Push Provider must have a unique `name`.
      Parameters:
      pushProvider - (required)
      Returns:
      PushProvider
      Throws:
      ApiException - if fails to make API call

    • createPushProvider

      public PushProvider createPushProvider(PushProvider pushProvider, Map<String,String> additionalHeaders) throws ApiException
      Create a push provider Creates a new push provider. Each Push Provider must have a unique `name`.
      Parameters:
      pushProvider - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      PushProvider
      Throws:
      ApiException - if fails to make API call

    • deletePushProvider

      public void deletePushProvider(String pushProviderId) throws ApiException
      Delete a push provider Deletes a push provider by `pushProviderId`. If the push provider is currently being used in the org by a custom authenticator, the delete will not be allowed.
      Parameters:
      pushProviderId - Id of the push provider (required)
      Throws:
      ApiException - if fails to make API call

    • deletePushProvider

      public void deletePushProvider(String pushProviderId, Map<String,String> additionalHeaders) throws ApiException
      Delete a push provider Deletes a push provider by `pushProviderId`. If the push provider is currently being used in the org by a custom authenticator, the delete will not be allowed.
      Parameters:
      pushProviderId - Id of the push provider (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getPushProvider

      public PushProvider getPushProvider(String pushProviderId) throws ApiException
      Retrieve a push provider Retrieves a push provider by `pushProviderId`
      Parameters:
      pushProviderId - Id of the push provider (required)
      Returns:
      PushProvider
      Throws:
      ApiException - if fails to make API call

    • getPushProvider

      public PushProvider getPushProvider(String pushProviderId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a push provider Retrieves a push provider by `pushProviderId`
      Parameters:
      pushProviderId - Id of the push provider (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      PushProvider
      Throws:
      ApiException - if fails to make API call

    • listPushProviders

      public List<PushProvider> listPushProviders(ProviderType type) throws ApiException
      List all push providers Lists all push providers
      Parameters:
      type - Filters push providers by `providerType` (optional)
      Returns:
      List<PushProvider>
      Throws:
      ApiException - if fails to make API call

    • listPushProviders

      public List<PushProvider> listPushProviders(ProviderType type, Map<String,String> additionalHeaders) throws ApiException
      List all push providers Lists all push providers
      Parameters:
      type - Filters push providers by `providerType` (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<PushProvider>
      Throws:
      ApiException - if fails to make API call

    • listPushProvidersPaged

      public Iterable<PushProvider> listPushProvidersPaged(ProviderType type)
      List all push providers (Paginated) Lists all push providers 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:
      type - Filters push providers by `providerType` (optional)
      Returns:
      Iterable<PushProvider> lazy iterable over all pages

    • listPushProvidersPaged

      public Iterable<PushProvider> listPushProvidersPaged(ProviderType type, Map<String,String> additionalHeaders)
      List all push providers (Paginated with additional headers) Lists all push providers This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      type - Filters push providers by `providerType` (optional)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<PushProvider> lazy iterable over all pages

    • replacePushProvider

      public PushProvider replacePushProvider(String pushProviderId, PushProvider pushProvider) throws ApiException
      Replace a push provider Replaces a push provider by `pushProviderId`
      Parameters:
      pushProviderId - Id of the push provider (required)
      pushProvider - (required)
      Returns:
      PushProvider
      Throws:
      ApiException - if fails to make API call

    • replacePushProvider

      public PushProvider replacePushProvider(String pushProviderId, PushProvider pushProvider, Map<String,String> additionalHeaders) throws ApiException
      Replace a push provider Replaces a push provider by `pushProviderId`
      Parameters:
      pushProviderId - Id of the push provider (required)
      pushProvider - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      PushProvider
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

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