Package com.okta.sdk.resource.api

Class SsfTransmitterApi

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

  • Constructor Details

    • SsfTransmitterApi

      public SsfTransmitterApi()

    • SsfTransmitterApi

      public SsfTransmitterApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createSsfStream

      public StreamConfiguration createSsfStream(StreamConfigurationCreateRequest instance) throws ApiException
      Create an SSF stream Creates an SSF Stream for an event receiver to start receiving security events in the form of Security Event Tokens (SETs) from Okta. An SSF Stream is associated with the Client ID of the OAuth 2.0 access token used to create the stream. The Client ID is provided by Okta for an [OAuth 2.0 app integration](https://help.okta.com/okta_help.htm?id=ext_Apps_App_Integration_Wizard-oidc). One SSF Stream is allowed for each Client ID, hence, one SSF Stream is allowed for each app integration in Okta. A maximum of 10 SSF Stream configurations can be created for one org.
      Parameters:
      instance - (required)
      Returns:
      StreamConfiguration
      Throws:
      ApiException - if fails to make API call

    • createSsfStream

      public StreamConfiguration createSsfStream(StreamConfigurationCreateRequest instance, Map<String,String> additionalHeaders) throws ApiException
      Create an SSF stream Creates an SSF Stream for an event receiver to start receiving security events in the form of Security Event Tokens (SETs) from Okta. An SSF Stream is associated with the Client ID of the OAuth 2.0 access token used to create the stream. The Client ID is provided by Okta for an [OAuth 2.0 app integration](https://help.okta.com/okta_help.htm?id=ext_Apps_App_Integration_Wizard-oidc). One SSF Stream is allowed for each Client ID, hence, one SSF Stream is allowed for each app integration in Okta. A maximum of 10 SSF Stream configurations can be created for one org.
      Parameters:
      instance - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      StreamConfiguration
      Throws:
      ApiException - if fails to make API call

    • deleteSsfStream

      public void deleteSsfStream(String streamId) throws ApiException
      Delete an SSF stream Deletes the specified SSF Stream. If the `stream_id` is not provided in the query string, the associated stream with the Client ID (through the request OAuth 2.0 access token) is deleted. Otherwise, the SSF Stream with the `stream_id` is deleted, if found.
      Parameters:
      streamId - The ID of the specified SSF Stream configuration (optional)
      Throws:
      ApiException - if fails to make API call

    • deleteSsfStream

      public void deleteSsfStream(String streamId, Map<String,String> additionalHeaders) throws ApiException
      Delete an SSF stream Deletes the specified SSF Stream. If the `stream_id` is not provided in the query string, the associated stream with the Client ID (through the request OAuth 2.0 access token) is deleted. Otherwise, the SSF Stream with the `stream_id` is deleted, if found.
      Parameters:
      streamId - The ID of the specified SSF Stream configuration (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getSsfStreamStatus

      public StreamStatus getSsfStreamStatus(String streamId) throws ApiException
      Retrieve the SSF Stream status Retrieves the status of an SSF Stream. The status indicates whether the transmitter is able to transmit events over the stream.
      Parameters:
      streamId - The ID of the specified SSF Stream configuration (required)
      Returns:
      StreamStatus
      Throws:
      ApiException - if fails to make API call

    • getSsfStreamStatus

      public StreamStatus getSsfStreamStatus(String streamId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the SSF Stream status Retrieves the status of an SSF Stream. The status indicates whether the transmitter is able to transmit events over the stream.
      Parameters:
      streamId - The ID of the specified SSF Stream configuration (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      StreamStatus
      Throws:
      ApiException - if fails to make API call

    • getSsfStreams

      public GetSsfStreams200Response getSsfStreams(String streamId) throws ApiException
      Retrieve the SSF stream configuration(s) Retrieves either a list of all known SSF Stream configurations or the individual configuration if specified by ID. As Stream configurations are tied to a Client ID, only the Stream associated with the Client ID of the request OAuth 2.0 access token can be viewed.
      Parameters:
      streamId - The ID of the specified SSF Stream configuration (optional)
      Returns:
      GetSsfStreams200Response
      Throws:
      ApiException - if fails to make API call

    • getSsfStreams

      public GetSsfStreams200Response getSsfStreams(String streamId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve the SSF stream configuration(s) Retrieves either a list of all known SSF Stream configurations or the individual configuration if specified by ID. As Stream configurations are tied to a Client ID, only the Stream associated with the Client ID of the request OAuth 2.0 access token can be viewed.
      Parameters:
      streamId - The ID of the specified SSF Stream configuration (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GetSsfStreams200Response
      Throws:
      ApiException - if fails to make API call

    • getWellknownSsfMetadata

      public WellKnownSSFMetadata getWellknownSsfMetadata() throws ApiException
      Retrieve the SSF transmitter metadata Retrieves SSF Transmitter configuration metadata. This includes all supported endpoints and key information about certain properties of the Okta org as the transmitter, such as `delivery_methods_supported`, `issuer`, and `jwks_uri`.
      Returns:
      WellKnownSSFMetadata
      Throws:
      ApiException - if fails to make API call

    • getWellknownSsfMetadata

      public WellKnownSSFMetadata getWellknownSsfMetadata(Map<String,String> additionalHeaders) throws ApiException
      Retrieve the SSF transmitter metadata Retrieves SSF Transmitter configuration metadata. This includes all supported endpoints and key information about certain properties of the Okta org as the transmitter, such as `delivery_methods_supported`, `issuer`, and `jwks_uri`.
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      WellKnownSSFMetadata
      Throws:
      ApiException - if fails to make API call

    • replaceSsfStream

      public StreamConfiguration replaceSsfStream(StreamConfiguration instance) throws ApiException
      Replace an SSF stream Replaces all properties for an existing SSF Stream configuration. If the `stream_id` isn't provided in the request body, the associated stream with the Client ID (through the request OAuth 2.0 access token) is replaced.
      Parameters:
      instance - (required)
      Returns:
      StreamConfiguration
      Throws:
      ApiException - if fails to make API call

    • replaceSsfStream

      public StreamConfiguration replaceSsfStream(StreamConfiguration instance, Map<String,String> additionalHeaders) throws ApiException
      Replace an SSF stream Replaces all properties for an existing SSF Stream configuration. If the `stream_id` isn't provided in the request body, the associated stream with the Client ID (through the request OAuth 2.0 access token) is replaced.
      Parameters:
      instance - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      StreamConfiguration
      Throws:
      ApiException - if fails to make API call

    • updateSsfStream

      public StreamConfiguration updateSsfStream(StreamConfiguration instance) throws ApiException
      Update an SSF stream Updates properties for an existing SSF Stream configuration. If the `stream_id` isn't provided in the request body, the associated stream with the Client ID (through the request OAuth 2.0 access token) is updated.
      Parameters:
      instance - (required)
      Returns:
      StreamConfiguration
      Throws:
      ApiException - if fails to make API call

    • updateSsfStream

      public StreamConfiguration updateSsfStream(StreamConfiguration instance, Map<String,String> additionalHeaders) throws ApiException
      Update an SSF stream Updates properties for an existing SSF Stream configuration. If the `stream_id` isn't provided in the request body, the associated stream with the Client ID (through the request OAuth 2.0 access token) is updated.
      Parameters:
      instance - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      StreamConfiguration
      Throws:
      ApiException - if fails to make API call

    • verifySsfStream

      public void verifySsfStream(StreamVerificationRequest instance) throws ApiException
      Verify an SSF stream Verifies an SSF Stream by publishing a Verification Event requested by a Security Events Provider. > **Note:** A successful response doesn't indicate that the Verification Event was transmitted successfully, only that Okta has transmitted the event or will at some point in the future. The SSF Receiver is responsible for validating and acknowledging successful transmission of the request by responding with HTTP Response Status Code 202.
      Parameters:
      instance - (required)
      Throws:
      ApiException - if fails to make API call

    • verifySsfStream

      public void verifySsfStream(StreamVerificationRequest instance, Map<String,String> additionalHeaders) throws ApiException
      Verify an SSF stream Verifies an SSF Stream by publishing a Verification Event requested by a Security Events Provider. > **Note:** A successful response doesn't indicate that the Verification Event was transmitted successfully, only that Okta has transmitted the event or will at some point in the future. The SSF Receiver is responsible for validating and acknowledging successful transmission of the request by responding with HTTP Response Status Code 202.
      Parameters:
      instance - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

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