PATCH /api/v1/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.
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 |
|---|---|---|---|
stream_id |
String | No |
The ID of the SSF Stream configuration |
min_verification_interval |
Integer | No |
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. |
format |
String | No |
The Subject Identifier format expected for any SET transmitted. Possible values:
|
aud |
No |
The audience used in the SET. This value is set as 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_delivered[] |
Array | No |
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_supported[] |
Array | No |
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. |
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 |
iss |
String | No |
The issuer used in Security Event Tokens (SETs). This value is set as 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. |
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.