COconductorone
SSF Receiver

Search

Changed on

Search performs a full-text search across received SSF events with optional filters for stream, event type, outcome, and matched user. Request a modest page_size (≤25) to keep responses small.

post/api/v1/search/ssf-receiver-events

Request

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

Request body

eventTypestring

Restricts results to events matching this wire event type URI. Optional.

matchedUserIdstring

Restricts results to events matched to this ConductorOne user ID. Optional.

outcome'SSF_EVENT_OUTCOME_UNSPECIFIED' | 'SSF_EVENT_OUTCOME_SESSIONS_REVOKED' | 'SSF_EVENT_OUTCOME_LOGGED' | 'SSF_EVENT_OUTCOME_PRINCIPAL_NOT_FOUND' | 'SSF_EVENT_OUTCOME_VERIFIED' | 'SSF_EVENT_OUTCOME_STREAM_STATUS_UPDATED' | 'SSF_EVENT_OUTCOME_UNRECOGNIZED' | 'SSF_EVENT_OUTCOME_ERROR'

Restricts results to events with this processing outcome. Optional.

pageSizeinteger

Maximum number of events to return per page.

pageTokenstring

Token from a previous SearchResponse to fetch the next page of results.

querystring

Full-text search query matched against event fields.

streamIdstring

Restricts results to events from this SSF receiver stream. Optional.

Response

SSFReceiverEventSearchServiceSearchResponse contains the matching events and a pagination token.

nextPageTokenstring

Token to retrieve the next page. Empty when there are no more results.

Changes