ssf_receivers

Creates, updates, deletes, gets or lists a ssf_receivers resource.

Overview

Name	ssf_receivers
Type	Resource
Id	okta.security_events_providers.ssf_receivers

Fields

The following fields are returned by SELECT queries:

list_security_events_provider_instances

Name	Datatype	Description
id	string	The unique identifier of this instance (example: sse1qg25RpusjUP6m0g5)
name	string	The name of the Security Events Provider instance (example: Target SSF Provider)
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
settings	object	Information about the Security Events Provider for signal ingestion (title: Security Events Provider settings)
status	string	Indicates whether the Security Events Provider is active or not
type	string	The application type of the Security Events Provider (example: okta)

get_security_events_provider_instance

Name	Datatype	Description
id	string	The unique identifier of this instance (example: sse1qg25RpusjUP6m0g5)
name	string	The name of the Security Events Provider instance (example: Target SSF Provider)
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
settings	object	Information about the Security Events Provider for signal ingestion (title: Security Events Provider settings)
status	string	Indicates whether the Security Events Provider is active or not
type	string	The application type of the Security Events Provider (example: okta)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_security_events_provider_instances	select	subdomain		Lists all Security Events Provider instances
get_security_events_provider_instance	select	subdomain		Retrieves the Security Events Provider instance specified by id
create_security_events_provider_instance	insert	subdomain, data__name, data__settings, data__type		Creates a Security Events Provider instance
replace_security_events_provider_instance	replace	subdomain, data__name, data__settings, data__type		Replaces a Security Events Provider instance specified by id
delete_security_events_provider_instance	delete	subdomain		Deletes a Security Events Provider instance specified by id
activate_security_events_provider_instance	exec	subdomain		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.
deactivate_security_events_provider_instance	exec	subdomain		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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
subdomain	string	The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains. (default: my-org)

SELECT examples

list_security_events_provider_instances

Lists all Security Events Provider instances

SELECT
id,
name,
_links,
settings,
status,
type
FROM okta.security_events_providers.ssf_receivers
WHERE subdomain = '{{ subdomain }}' -- required;

get_security_events_provider_instance

Retrieves the Security Events Provider instance specified by id

SELECT
id,
name,
_links,
settings,
status,
type
FROM okta.security_events_providers.ssf_receivers
WHERE subdomain = '{{ subdomain }}' -- required;

INSERT examples

create_security_events_provider_instance

Creates a Security Events Provider instance

INSERT INTO okta.security_events_providers.ssf_receivers (
data__name,
data__settings,
data__type,
subdomain
)
SELECT 
'{{ name }}' --required,
'{{ settings }}' --required,
'{{ type }}' --required,
'{{ subdomain }}'
RETURNING
id,
name,
_links,
settings,
status,
type
;

Manifest

# Description fields are for documentation purposes
- name: ssf_receivers
  props:
    - name: subdomain
      value: string
      description: Required parameter for the ssf_receivers resource.
    - name: name
      value: string
      description: >
        The name of the Security Events Provider instance
        
    - name: settings
      value: object
      description: >
        Information about the Security Events Provider for signal ingestion
        
    - name: type
      value: string
      description: >
        The application type of the Security Events Provider
        

REPLACE examples

replace_security_events_provider_instance

Replaces a Security Events Provider instance specified by id

REPLACE okta.security_events_providers.ssf_receivers
SET 
data__name = '{{ name }}',
data__settings = '{{ settings }}',
data__type = '{{ type }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND data__name = '{{ name }}' --required
AND data__settings = '{{ settings }}' --required
AND data__type = '{{ type }}' --required
RETURNING
id,
name,
_links,
settings,
status,
type;

DELETE examples

delete_security_events_provider_instance

Deletes a Security Events Provider instance specified by id

DELETE FROM okta.security_events_providers.ssf_receivers
WHERE subdomain = '{{ subdomain }}' --required;

Lifecycle Methods

activate_security_events_provider_instance

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.

EXEC okta.security_events_providers.ssf_receivers.activate_security_events_provider_instance 
@subdomain='{{ subdomain }}' --required;

deactivate_security_events_provider_instance

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.

EXEC okta.security_events_providers.ssf_receivers.deactivate_security_events_provider_instance 
@subdomain='{{ subdomain }}' --required;