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:

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 (ACTIVE, INACTIVE)
type	string	The app type of the security events provider (example: okta)

list_security_events_provider_instances

The security events provider response

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 (ACTIVE, INACTIVE)
type	string	The app 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
get_security_events_provider_instance	select	securityEventProviderId, subdomain		Retrieves the security events provider instance specified by id
list_security_events_provider_instances	select	subdomain		Lists all security events provider instances
create_security_events_provider_instance	insert	subdomain, name, settings, type		Creates a security events provider instance
replace_security_events_provider_instance	replace	securityEventProviderId, subdomain, name, settings, type		Replaces a security events provider instance specified by id
delete_security_events_provider_instance	delete	securityEventProviderId, subdomain		Deletes a security events provider instance specified by id
activate_security_events_provider_instance	exec	securityEventProviderId, 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	securityEventProviderId, 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
securityEventProviderId	string	id of the security events provider instance
subdomain	string	(default: my-org)

SELECT examples

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 securityEventProviderId = '{{ securityEventProviderId }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

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
;

INSERT examples

create_security_events_provider_instance

Creates a security events provider instance

INSERT INTO okta.security_events_providers.ssf_receivers (
name,
settings,
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: "{{ subdomain }}"
    description: Required parameter for the ssf_receivers resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the security events provider instance
  - name: settings
    description: |
      Information about the security events provider for signal ingestion
    value:
      well_known_url: "{{ well_known_url }}"
      issuer: "{{ issuer }}"
      jwks_url: "{{ jwks_url }}"
  - name: type
    value: "{{ type }}"
    description: |
      The app 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 
name = '{{ name }}',
settings = '{{ settings }}',
type = '{{ type }}'
WHERE 
securityEventProviderId = '{{ securityEventProviderId }}' --required
AND subdomain = '{{ subdomain }}' --required
AND name = '{{ name }}' --required
AND settings = '{{ settings }}' --required
AND 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 securityEventProviderId = '{{ securityEventProviderId }}' --required
AND 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 
@securityEventProviderId='{{ securityEventProviderId }}' --required, 
@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 
@securityEventProviderId='{{ securityEventProviderId }}' --required, 
@subdomain='{{ subdomain }}' --required
;