Create SSF stream

POST

/v1/signals/stream

curl --request POST \
  --url http://localhost:8693/v1/signals/stream \
  --header 'Content-Type: application/json' \
  --data '{ "iss": "starfly", "aud": "downstream-consumer", "events_requested": [ "https://schemas.openid.net/secevent/caep/event-type/session-revoked", "https://schemas.openid.net/secevent/caep/event-type/credential-change" ], "delivery_method": "push", "endpoint_url": "https://consumer.example.com/events" }'

• Plaintext (dev mode)
• mTLS (production)

Creates a new SSF event stream. The endpoint URL must use HTTPS (localhost/127.0.0.1 exempted for dev/test).

Protected by mTLS when TLS is enabled.

Request Body ^required

Media type application/json

object

iss

required

string

aud

required

string

events_requested

required

Array<string>

events_delivered

Array<string>

delivery_method

required

string

Allowed values: push poll

endpoint_url

HTTPS endpoint for push delivery (must be HTTPS, except localhost)

string

Example

{
  "iss": "starfly",
  "aud": "downstream-consumer",
  "events_requested": [
    "https://schemas.openid.net/secevent/caep/event-type/session-revoked",
    "https://schemas.openid.net/secevent/caep/event-type/credential-change"
  ],
  "delivery_method": "push",
  "endpoint_url": "https://consumer.example.com/events"
}

Responses

201

Stream created

Media type application/json

object

stream_id

string

iss

string

aud

string

events_supported

Array<string>

status

string

Allowed values: enabled paused disabled

Example

{
  "status": "enabled"
}

400

Invalid request

Media type application/json

object

error

required

Error code (RFC 8693 compatible)

string

Allowed values: invalid_request unsupported_grant_type access_denied server_error not_implemented not_found method_not_allowed

error_description

Human-readable error detail

string

Example

{
  "error": "invalid_request"
}

501

Signal transmitter not configured

Media type application/json

object

error

required

Error code (RFC 8693 compatible)

string

Allowed values: invalid_request unsupported_grant_type access_denied server_error not_implemented not_found method_not_allowed

error_description

Human-readable error detail

string

Example

{
  "error": "invalid_request"
}