Package com.okta.sdk.resource.api

Class SsfReceiverApi

java.lang.Object

com.okta.sdk.resource.api.SsfReceiverApi

@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 SsfReceiverApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SsfReceiverApi()
SsfReceiverApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SecurityEventsProviderResponse	activateSecurityEventsProviderInstance(String securityEventProviderId)	Activate a security events provider Activates a Security Events Provider instance by setting its status to `ACTIVE`.
SecurityEventsProviderResponse	activateSecurityEventsProviderInstance(String securityEventProviderId, Map<String,String> additionalHeaders)	Activate a security events provider Activates a Security Events Provider instance by setting its status to `ACTIVE`.
SecurityEventsProviderResponse	createSecurityEventsProviderInstance(SecurityEventsProviderRequest instance)	Create a security events provider Creates a Security Events Provider instance
SecurityEventsProviderResponse	createSecurityEventsProviderInstance(SecurityEventsProviderRequest instance, Map<String,String> additionalHeaders)	Create a security events provider Creates a Security Events Provider instance
SecurityEventsProviderResponse	deactivateSecurityEventsProviderInstance(String securityEventProviderId)	Deactivate a security events provider Deactivates a Security Events Provider instance by setting its status to `INACTIVE`.
SecurityEventsProviderResponse	deactivateSecurityEventsProviderInstance(String securityEventProviderId, Map<String,String> additionalHeaders)	Deactivate a security events provider Deactivates a Security Events Provider instance by setting its status to `INACTIVE`.
void	deleteSecurityEventsProviderInstance(String securityEventProviderId)	Delete a security events provider Deletes a Security Events Provider instance specified by `id`
void	deleteSecurityEventsProviderInstance(String securityEventProviderId, Map<String,String> additionalHeaders)	Delete a security events provider Deletes a Security Events Provider instance specified by `id`
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
SecurityEventsProviderResponse	getSecurityEventsProviderInstance(String securityEventProviderId)	Retrieve the security events provider Retrieves the Security Events Provider instance specified by `id`
SecurityEventsProviderResponse	getSecurityEventsProviderInstance(String securityEventProviderId, Map<String,String> additionalHeaders)	Retrieve the security events provider Retrieves the Security Events Provider instance specified by `id`
List<SecurityEventsProviderResponse>	listSecurityEventsProviderInstances()	List all security events providers Lists all Security Events Provider instances
List<SecurityEventsProviderResponse>	listSecurityEventsProviderInstances(Map<String,String> additionalHeaders)	List all security events providers Lists all Security Events Provider instances
Iterable<SecurityEventsProviderResponse>	listSecurityEventsProviderInstancesPaged()	List all security events providers (Paginated) Lists all Security Events Provider instances This method returns a lazy, paginated iterable that automatically handles pagination.
Iterable<SecurityEventsProviderResponse>	listSecurityEventsProviderInstancesPaged(Map<String,String> additionalHeaders)	List all security events providers (Paginated with additional headers) Lists all Security Events Provider instances This method returns a lazy, paginated iterable that automatically handles pagination.
SecurityEventsProviderResponse	replaceSecurityEventsProviderInstance(String securityEventProviderId, SecurityEventsProviderRequest instance)	Replace a security events provider Replaces a Security Events Provider instance specified by `id`
SecurityEventsProviderResponse	replaceSecurityEventsProviderInstance(String securityEventProviderId, SecurityEventsProviderRequest instance, Map<String,String> additionalHeaders)	Replace a security events provider Replaces a Security Events Provider instance specified by `id`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SsfReceiverApi

public SsfReceiverApi()

SsfReceiverApi

public SsfReceiverApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateSecurityEventsProviderInstance

public SecurityEventsProviderResponse activateSecurityEventsProviderInstance(String securityEventProviderId)
                                                                      throws ApiException

Activate a security events provider Activates a Security Events Provider instance by setting its status to `ACTIVE`. This operation resumes the flow of events from the Security Events Provider to Okta.

Parameters:

securityEventProviderId - `id` of the Security Events Provider instance (required)

Returns:

SecurityEventsProviderResponse

Throws:

ApiException - if fails to make API call

activateSecurityEventsProviderInstance

public SecurityEventsProviderResponse activateSecurityEventsProviderInstance(String securityEventProviderId,
 Map<String,String> additionalHeaders)
                                                                      throws ApiException

Activate a security events provider Activates a Security Events Provider instance by setting its status to `ACTIVE`. This operation resumes the flow of events from the Security Events Provider to Okta.

Parameters:

securityEventProviderId - `id` of the Security Events Provider instance (required)

additionalHeaders - additionalHeaders for this call

Returns:

SecurityEventsProviderResponse

Throws:

ApiException - if fails to make API call

createSecurityEventsProviderInstance

public SecurityEventsProviderResponse createSecurityEventsProviderInstance(SecurityEventsProviderRequest instance)
                                                                    throws ApiException

Create a security events provider Creates a Security Events Provider instance

Parameters:

instance - (required)

Returns:

SecurityEventsProviderResponse

Throws:

ApiException - if fails to make API call

createSecurityEventsProviderInstance

public SecurityEventsProviderResponse createSecurityEventsProviderInstance(SecurityEventsProviderRequest instance,
 Map<String,String> additionalHeaders)
                                                                    throws ApiException

Create a security events provider Creates a Security Events Provider instance

Parameters:

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

SecurityEventsProviderResponse

Throws:

ApiException - if fails to make API call

deactivateSecurityEventsProviderInstance

public SecurityEventsProviderResponse deactivateSecurityEventsProviderInstance(String securityEventProviderId)
                                                                        throws ApiException

Deactivate a security events provider Deactivates a Security Events Provider instance by setting its status to `INACTIVE`. This operation stops the flow of events from the Security Events Provider to Okta.

Parameters:

securityEventProviderId - `id` of the Security Events Provider instance (required)

Returns:

SecurityEventsProviderResponse

Throws:

ApiException - if fails to make API call

deactivateSecurityEventsProviderInstance

public SecurityEventsProviderResponse deactivateSecurityEventsProviderInstance(String securityEventProviderId,
 Map<String,String> additionalHeaders)
                                                                        throws ApiException

Deactivate a security events provider Deactivates a Security Events Provider instance by setting its status to `INACTIVE`. This operation stops the flow of events from the Security Events Provider to Okta.

Parameters:

securityEventProviderId - `id` of the Security Events Provider instance (required)

additionalHeaders - additionalHeaders for this call

Returns:

SecurityEventsProviderResponse

Throws:

ApiException - if fails to make API call

deleteSecurityEventsProviderInstance

public void deleteSecurityEventsProviderInstance(String securityEventProviderId)
                                          throws ApiException

Delete a security events provider Deletes a Security Events Provider instance specified by `id`

Parameters:

securityEventProviderId - `id` of the Security Events Provider instance (required)

Throws:

ApiException - if fails to make API call

deleteSecurityEventsProviderInstance

public void deleteSecurityEventsProviderInstance(String securityEventProviderId,
 Map<String,String> additionalHeaders)
                                          throws ApiException

Delete a security events provider Deletes a Security Events Provider instance specified by `id`

Parameters:

securityEventProviderId - `id` of the Security Events Provider instance (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getSecurityEventsProviderInstance

public SecurityEventsProviderResponse getSecurityEventsProviderInstance(String securityEventProviderId)
                                                                 throws ApiException

Retrieve the security events provider Retrieves the Security Events Provider instance specified by `id`

Parameters:

securityEventProviderId - `id` of the Security Events Provider instance (required)

Returns:

SecurityEventsProviderResponse

Throws:

ApiException - if fails to make API call

getSecurityEventsProviderInstance

public SecurityEventsProviderResponse getSecurityEventsProviderInstance(String securityEventProviderId,
 Map<String,String> additionalHeaders)
                                                                 throws ApiException

Retrieve the security events provider Retrieves the Security Events Provider instance specified by `id`

Parameters:

securityEventProviderId - `id` of the Security Events Provider instance (required)

additionalHeaders - additionalHeaders for this call

Returns:

SecurityEventsProviderResponse

Throws:

ApiException - if fails to make API call

listSecurityEventsProviderInstances

public List<SecurityEventsProviderResponse> listSecurityEventsProviderInstances()
                                                                         throws ApiException

List all security events providers Lists all Security Events Provider instances

Returns:

List<SecurityEventsProviderResponse>

Throws:

ApiException - if fails to make API call

listSecurityEventsProviderInstances

public List<SecurityEventsProviderResponse> listSecurityEventsProviderInstances(Map<String,String> additionalHeaders)
                                                                         throws ApiException

List all security events providers Lists all Security Events Provider instances

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

List<SecurityEventsProviderResponse>

Throws:

ApiException - if fails to make API call

listSecurityEventsProviderInstancesPaged

public Iterable<SecurityEventsProviderResponse> listSecurityEventsProviderInstancesPaged()

List all security events providers (Paginated) Lists all Security Events Provider instances 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<SecurityEventsProviderResponse> lazy iterable over all pages

listSecurityEventsProviderInstancesPaged

public Iterable<SecurityEventsProviderResponse> listSecurityEventsProviderInstancesPaged(Map<String,String> additionalHeaders)

List all security events providers (Paginated with additional headers) Lists all Security Events Provider instances 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<SecurityEventsProviderResponse> lazy iterable over all pages

replaceSecurityEventsProviderInstance

public SecurityEventsProviderResponse replaceSecurityEventsProviderInstance(String securityEventProviderId,
 SecurityEventsProviderRequest instance)
                                                                     throws ApiException

Replace a security events provider Replaces a Security Events Provider instance specified by `id`

Parameters:

securityEventProviderId - `id` of the Security Events Provider instance (required)

instance - (required)

Returns:

SecurityEventsProviderResponse

Throws:

ApiException - if fails to make API call

replaceSecurityEventsProviderInstance

public SecurityEventsProviderResponse replaceSecurityEventsProviderInstance(String securityEventProviderId,
 SecurityEventsProviderRequest instance,
 Map<String,String> additionalHeaders)
                                                                     throws ApiException

Replace a security events provider Replaces a Security Events Provider instance specified by `id`

Parameters:

securityEventProviderId - `id` of the Security Events Provider instance (required)

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

SecurityEventsProviderResponse

Throws:

ApiException - if fails to make API call

getObjectMapper

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