COconductorone
SSF Receiver

Create

Changed on

Create registers a new SSF receiver stream with the specified configuration and returns the created stream along with the push auth token (if push delivery).

post/api/v1/ssf-receiver-streams

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/ssf-receiver-streams
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

accountDisabledAction'SSF_REVOCATION_ACTION_UNSPECIFIED' | 'SSF_REVOCATION_ACTION_REVOKE_ALL' | 'SSF_REVOCATION_ACTION_LOG_ONLY'

Action to take when an account-disabled event is received.

credentialChangeAction'SSF_REVOCATION_ACTION_UNSPECIFIED' | 'SSF_REVOCATION_ACTION_REVOKE_ALL' | 'SSF_REVOCATION_ACTION_LOG_ONLY'

Action to take when a credential-change event is received.

credentialCompromiseAction'SSF_REVOCATION_ACTION_UNSPECIFIED' | 'SSF_REVOCATION_ACTION_REVOKE_ALL' | 'SSF_REVOCATION_ACTION_LOG_ONLY'

Action to take when a credential-compromise event is received.

deliveryMethod'SSF_DELIVERY_METHOD_UNSPECIFIED' | 'SSF_DELIVERY_METHOD_PUSH' | 'SSF_DELIVERY_METHOD_POLL'

Controls whether events are received via push or poll delivery.

descriptionstring

Optional description of the stream's purpose or source.

displayNamestring required

Human-readable name for the stream.

enabledboolean

Controls whether the stream starts processing events immediately after creation.

expectedAudiencestring

Expected audience claim in incoming SETs. If set, SETs with a different audience are rejected.

issuerUrlstring required

The issuer URL of the upstream SSF transmitter, used for token validation.

jwksUrlstring

URL to fetch the transmitter's JSON Web Key Set for SET signature verification.

pollEndpointUrlstring

URL of the transmitter's poll endpoint. Required when delivery_method is POLL.

pollIntervalstring duration nullable
sessionRevokedAction'SSF_REVOCATION_ACTION_UNSPECIFIED' | 'SSF_REVOCATION_ACTION_REVOKE_ALL' | 'SSF_REVOCATION_ACTION_LOG_ONLY'

Per-event-type action configuration. Action to take when a session-revoked event is received.

Response

SSFReceiverStreamServiceCreateResponse returns the created stream and the push auth token in plaintext.

pushAuthTokenPlaintextstring

Push auth token returned in plaintext ONLY on create.

Changes

  • f2cf3228f366Revision changes
    • breaking

      added subschema #2 to the response property oneOf list for the response status

    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      the request property became nullable

  • fa2bb307d6faRevision changes
    • info

      endpoint added