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="2024-08-09T14:19:33.269913-05:00[America/Chicago]",
comments="Generator version: 7.7.0")
public class PushProviderApi
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreatePushProvider
(PushProvider pushProvider) Create a Push Provider Creates a new push provider.createPushProvider
(PushProvider pushProvider, Map<String, String> additionalHeaders) Create a Push Provider Creates a new push provider.void
deletePushProvider
(String pushProviderId) Delete a Push Provider Deletes a push provider by `pushProviderId`.void
deletePushProvider
(String pushProviderId, Map<String, String> additionalHeaders) Delete a Push Provider Deletes a push provider by `pushProviderId`.protected static com.fasterxml.jackson.databind.ObjectMapper
getPushProvider
(String pushProviderId) Retrieve a Push Provider Retrieves a push provider by `pushProviderId`getPushProvider
(String pushProviderId, Map<String, String> additionalHeaders) Retrieve a Push Provider Retrieves a push provider by `pushProviderId`List all Push Providers Lists all push providerslistPushProviders
(ProviderType type, Map<String, String> additionalHeaders) List all Push Providers Lists all push providersreplacePushProvider
(String pushProviderId, PushProvider pushProvider) Replace a Push Provider Replaces a push provider by `pushProviderId`replacePushProvider
(String pushProviderId, PushProvider pushProvider, Map<String, String> additionalHeaders) Replace a Push Provider Replaces a push provider by `pushProviderId`void
setApiClient
(ApiClient apiClient)
-
Constructor Details
-
PushProviderApi
public PushProviderApi() -
PushProviderApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
createPushProvider
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 ApiExceptionCreate 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
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 ApiExceptionDelete 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
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 ApiExceptionRetrieve 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
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 ApiExceptionList 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
-
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 ApiExceptionReplace 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()
-