Britive Shared Signals - Results API

openapi: 3.2.0
info:
  title: Britive Services API Documentation Shared Signals - Results API
  version: v1
  description: API documentation for Users, Tags, Identity providers, Applications, Reporting, Audit logs, Tenants, SSO, Profiles, Password policies, MFA, Access Builder Settings, etc.
servers:
- url: https://{tenantURL}
  description: The primary server
  variables:
    tenantURL:
      default: test.britive-app.com
      description: The host of the server
security:
- bearerAuth: []
tags:
- name: Shared Signals - Results
  description: Query shared signals processing results
paths:
  /api/ssf/results:
    get:
      tags:
      - Shared Signals - Results
      summary: Query processed shared signals event results
      description: 'Results are returned in descending order by `receivedAt` (newest first).

        Ordering is fixed to ensure stable pagination with `nextToken`.

        '
      operationId: querySsfResults
      parameters:
      - in: query
        name: subjectValue
        schema:
          type: string
        required: false
        description: Filter by subject identifier value (e.g. email address).
      - in: query
        name: limit
        required: false
        description: Maximum number of results per page. Default 20, max 100.
        schema:
          type: integer
          default: 20
      - in: query
        name: nextToken
        schema:
          type: string
      - in: query
        name: direction
        schema:
          $ref: '#/components/schemas/Direction'
        required: false
        description: Filter by event direction. Omit to return all.
      responses:
        '200':
          description: Results page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QueryResultsResponse'
components:
  schemas:
    SsfProcessingResult:
      type: object
      required:
      - resultId
      - issuerId
      - issuerUrl
      - eventUri
      - subject
      - action
      - status
      - receivedAt
      properties:
        resultId:
          type: string
        issuerId:
          type: string
        eventUri:
          type: string
          format: uri
        issuerUrl:
          type: string
          format: uri
        direction:
          $ref: '#/components/schemas/Direction'
          description: RECEIVED = inbound from external IdP, TRANSMITTED = outbound to receiver. Absent on records written before this field was introduced; treat as RECEIVED.
        receiverUrl:
          type:
          - string
          - 'null'
          format: uri
          description: Receiver endpoint URL. Only present for TRANSMITTED events; null for RECEIVED.
        subject:
          $ref: '#/components/schemas/SubjectIdentifier'
        action:
          type: string
        status:
          $ref: '#/components/schemas/ProcessingStatus'
        receivedAt:
          type: string
          format: date-time
        processedAt:
          type:
          - string
          - 'null'
          format: date-time
        outcome:
          $ref: '#/components/schemas/ActionOutcome'
        rawSsfEvent:
          type: object
          additionalProperties: 'true'
    Direction:
      type: string
      enum:
      - RECEIVED
      - TRANSMITTED
    ActionOutcome:
      type: object
      properties:
        success:
          type: boolean
        code:
          type: string
          description: Optional machine-readable code (e.g., USER_NOT_FOUND)
        message:
          type: string
          description: Optional human-readable message
        details:
          type: object
          additionalProperties: 'true'
    QueryResultsResponse:
      type: object
      required:
      - items
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/SsfProcessingResult'
        nextToken:
          type:
          - string
          - 'null'
    ProcessingStatus:
      type: string
      enum:
      - ACCEPTED
      - FAILED
    SubjectIdentifier:
      type: object
      required:
      - type
      - value
      properties:
        type:
          type: string
          description: v1 supports email only (aligns with current design)
          enum:
          - email
        value:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
x-api-evangelist:
  assembled_from: https://docs.britive.com/apidocs/ (one OpenAPI fragment per operation page, .md variant)
  assembled_on: '2026-08-08'
  fragments: 372
  note: Britive publishes this contract only as per-operation fragments inside its Document360 API reference. This file is the faithful union of those fragments; the verbatim assembly is in openapi/_original/.