POST /api/v1/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. 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.
Servers
- https://{yourOktaDomain}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
format |
String | No |
The Subject Identifier format expected for any SET transmitted. Possible values:
|
events_requested[] |
Array | Yes |
The events (mapped by the array of event type URIs) that the receiver wants to receive |
delivery |
Object | Yes |
Contains information about the intended SET delivery method by the receiver |
delivery.method |
String | Yes |
The delivery method that the transmitter uses for delivering a SET Possible values:
|
delivery.authorization_header |
String | No |
The HTTP Authorization header that is included for each HTTP POST request |
delivery.endpoint_url |
String | Yes |
The target endpoint URL where the transmitter delivers the SET using HTTP POST requests |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.