ssf_stream_status
Creates, updates, deletes, gets or lists a ssf_stream_status resource.
Overview
| Name | ssf_stream_status |
| Type | Resource |
| Id | okta.ssf.ssf_stream_status |
Fields
The following fields are returned by SELECT queries:
- get_ssf_stream_status
| Name | Datatype | Description |
|---|---|---|
stream_id | string | The ID of the SSF Stream configuration. This corresponds to the value in the query parameter of the request. (example: esc1k235GIIztAuGK0g5) |
status | string | The status of the SSF Stream configuration |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_ssf_stream_status | select | stream_id, subdomain | Retrieves the status of an SSF Stream. The status indicates whether the transmitter is able to transmit events over the stream. |
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 |
|---|---|---|
stream_id | string | The ID of the specified SSF Stream configuration (example: esc1k235GIIztAuGK0g5) |
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
- get_ssf_stream_status
Retrieves the status of an SSF Stream. The status indicates whether the transmitter is able to transmit events over the stream.
SELECT
stream_id,
status
FROM okta.ssf.ssf_stream_status
WHERE stream_id = '{{ stream_id }}' -- required
AND subdomain = '{{ subdomain }}' -- required;