ssf_streams

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

Overview

Name	`ssf_streams`
Type	Resource
Id	`okta.ssf.ssf_streams`

Fields

The following fields are returned by SELECT queries:

get_ssf_streams

Name	Datatype	Description
`stream_id`	`string`	The ID of the SSF stream configuration (example: esc1k235GIIztAuGK0g5)
`aud`	`string (uri)`	The audience used in the SET. This value is set as `aud` in the claim. A read-only parameter that is set by the transmitter. If this parameter is included in the request, the value must match the expected value from the transmitter. (example: https://example.com)
`delivery`	`object`	Contains information about the intended SET delivery method by the receiver (title: Stream configuration delivery)
`events_delivered`	`array`	The events (mapped by the array of event type URIs) that the transmitter actually delivers to the SSF stream. A read-only parameter that is set by the transmitter. If this parameter is included in the request, the value must match the expected value from the transmitter.
`events_requested`	`array`	The events (mapped by the array of event type URIs) that the receiver wants to receive
`events_supported`	`array`	An array of event type URIs that the transmitter supports. A read-only parameter that is set by the transmitter. If this parameter is included in the request, the value must match the expected value from the transmitter.
`format`	`string`	The subject identifier format expected for any SET transmitted. (iss_sub)
`iss`	`string`	The issuer used in security event tokens (SETs). This value is set as `iss` in the claim. A read-only parameter that is set by the transmitter. If this parameter is included in the request, the value must match the expected value from the transmitter. (example: https://{yourOktaDomain})
`min_verification_interval`	`integer`	The minimum amount of time, in seconds, between two verification requests. A read-only parameter that is set by the transmitter. If this parameter is included in the request, the value must match the expected value from the transmitter.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_ssf_streams`	`select`	`subdomain`	`stream_id`	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, you can only view the stream associated with the client ID of the request OAuth 2.0 access token.
`create_ssf_stream`	`insert`	`subdomain`, `events_requested`, `delivery`		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. One SSF stream is allowed for each client ID, hence, one SSF stream is allowed for each app integration in Okta. You can create a maximum of 10 SSF stream configurations for one org.
`update_ssf_stream`	`update`	`subdomain`, `events_requested`, `delivery`		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.
`replace_ssf_stream`	`replace`	`subdomain`, `events_requested`, `delivery`		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.
`delete_ssf_stream`	`delete`	`subdomain`	`stream_id`	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.
`verify_ssf_stream`	`exec`	`subdomain`, `stream_id`		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

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`	(default: my-org)
`stream_id`	`string`	The ID of the specified SSF Stream configuration (example: esc1k235GIIztAuGK0g5)

`SELECT` examples

get_ssf_streams

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, you can only view the stream associated with the client ID of the request OAuth 2.0 access token.

SELECT
stream_id,
aud,
delivery,
events_delivered,
events_requested,
events_supported,
format,
iss,
min_verification_interval
FROM okta.ssf.ssf_streams
WHERE subdomain = '{{ subdomain }}' -- required
AND stream_id = '{{ stream_id }}'
;

`INSERT` examples

create_ssf_stream
Manifest

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. One SSF stream is allowed for each client ID, hence, one SSF stream is allowed for each app integration in Okta.

You can create a maximum of 10 SSF stream configurations for one org.

INSERT INTO okta.ssf.ssf_streams (
delivery,
events_requested,
format,
subdomain
)
SELECT 
'{{ delivery }}' /* required */,
'{{ events_requested }}' /* required */,
'{{ format }}',
'{{ subdomain }}'
RETURNING
stream_id,
aud,
delivery,
events_delivered,
events_requested,
events_supported,
format,
iss,
min_verification_interval
;

# Description fields are for documentation purposes
- name: ssf_streams
props:
  - name: subdomain
    value: "{{ subdomain }}"
    description: Required parameter for the ssf_streams resource.
  - name: delivery
    description: |
      Contains information about the intended SET delivery method by the receiver
    value:
      authorization_header: "{{ authorization_header }}"
      endpoint_url: "{{ endpoint_url }}"
      method: "{{ method }}"
  - name: events_requested
    value:
      - "{{ events_requested }}"
    description: |
      The events (mapped by the array of event type URIs) that the receiver wants to receive
  - name: format
    value: "{{ format }}"
    description: |
      The subject identifier format expected for any SET transmitted.
    valid_values: ['iss_sub']

`UPDATE` examples

update_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.

UPDATE okta.ssf.ssf_streams
SET 
aud = '{{ aud }}',
delivery = '{{ delivery }}',
events_delivered = '{{ events_delivered }}',
events_requested = '{{ events_requested }}',
events_supported = '{{ events_supported }}',
format = '{{ format }}',
iss = '{{ iss }}',
min_verification_interval = {{ min_verification_interval }},
stream_id = '{{ stream_id }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND events_requested = '{{ events_requested }}' --required
AND delivery = '{{ delivery }}' --required
RETURNING
stream_id,
aud,
delivery,
events_delivered,
events_requested,
events_supported,
format,
iss,
min_verification_interval;

`REPLACE` examples

replace_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.

REPLACE okta.ssf.ssf_streams
SET 
aud = '{{ aud }}',
delivery = '{{ delivery }}',
events_delivered = '{{ events_delivered }}',
events_requested = '{{ events_requested }}',
events_supported = '{{ events_supported }}',
format = '{{ format }}',
iss = '{{ iss }}',
min_verification_interval = {{ min_verification_interval }},
stream_id = '{{ stream_id }}'
WHERE 
subdomain = '{{ subdomain }}' --required
AND events_requested = '{{ events_requested }}' --required
AND delivery = '{{ delivery }}' --required
RETURNING
stream_id,
aud,
delivery,
events_delivered,
events_requested,
events_supported,
format,
iss,
min_verification_interval;

`DELETE` examples

delete_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.

DELETE FROM okta.ssf.ssf_streams
WHERE subdomain = '{{ subdomain }}' --required
AND stream_id = '{{ stream_id }}'
;

Lifecycle Methods

verify_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.

EXEC okta.ssf.ssf_streams.verify_ssf_stream 
@subdomain='{{ subdomain }}' --required 
@@json=
'{
"state": "{{ state }}", 
"stream_id": "{{ stream_id }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​

Lifecycle Methods​