Search

Search performs a full-text search across received SSF events with optional filters for stream, event type, outcome, and matched user.

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

Search

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.SSFReceiverEventSearch.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.SSFReceiverEventSearchServiceSearchResponse != nil {
        // handle response
    }
}

200

{
  "list": [
    {
      "canonicalType": "SSF_CANONICAL_EVENT_TYPE_UNSPECIFIED",
      "id": "<string>",
      "matchMethod": "SSF_SUBJECT_MATCH_METHOD_UNSPECIFIED",
      "matchedUserId": "<string>",
      "outcome": "SSF_EVENT_OUTCOME_UNSPECIFIED",
      "outcomeDetail": "<string>",
      "receivedAt": "2023-11-07T05:31:56Z",
      "sessionsRevoked": 123,
      "setJti": "<string>",
      "streamId": "<string>",
      "wireEventProfile": "<string>",
      "wireEventType": "<string>",
      "wireInitiatingEntity": "<string>",
      "wireReasonAdmin": "<string>",
      "wireSubjectFormat": "<string>",
      "wireSubjectIdentifier": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

SSFReceiverEventSearchServiceSearchRequest carries the search query and optional filters for narrowing results.

eventType · string

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

matchedUserId · string

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

outcome · enum<string>

Restricts results to events with this processing outcome. Optional.

Available options: 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

pageSize · integer<int32>

Maximum number of events to return per page.

pageToken · string

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

query · string

Full-text search query matched against event fields.

streamId · string

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

Response

200 - application/json

SSFReceiverEventSearchServiceSearchResponse contains the matching events and a pagination token.

SSFReceiverEventSearchServiceSearchResponse contains the matching events and a pagination token.

list · Ssf Receiver Event · object[] | null

The SSF events matching the search criteria.

Show child attributes

nextPageToken · string

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