1Password Stream Audit Events

arazzo: 1.0.1
info:
  title: 1Password Stream Audit Events
  summary: Validate the Events token, open an audit event feed from a start time, then page with the cursor.
  description: >-
    The 1Password Events API feed pattern for audit events. The workflow first
    introspects the bearer token to confirm it is valid and carries the required
    features, then opens the audit event feed with a ResetCursor start time to
    retrieve the first page, and finally continues paging using the cursor
    returned by the previous response. Each step spells out its request inline so
    the flow can be read and executed without opening the underlying OpenAPI
    description.
  version: 1.0.0
sourceDescriptions:
- name: auditEventsApi
  url: ../openapi/1password-audit-events-api-openapi.yml
  type: openapi
- name: introspectionApi
  url: ../openapi/1password-introspection-api-openapi.yml
  type: openapi
workflows:
- workflowId: stream-audit-events
  summary: Open an audit event feed from a start time and continue paging with the cursor.
  description: >-
    Confirms the Events token is valid, opens the audit event feed from the
    supplied start time, and then fetches the next page of audit events using the
    cursor returned by the first request.
  inputs:
    type: object
    required:
    - startTime
    properties:
      startTime:
        type: string
        description: An ISO 8601 timestamp to begin fetching audit events from.
      limit:
        type: integer
        description: The maximum number of audit event records to return per page.
  steps:
  - stepId: introspectToken
    description: >-
      Introspect the bearer token to confirm it is valid and carries the
      features required to read audit events.
    operationId: introspectToken
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      uuid: $response.body#/uuid
  - stepId: openFeed
    description: >-
      Open the audit event feed using a ResetCursor start time to retrieve the
      first page of audit events.
    operationId: listAuditEventsV2
    requestBody:
      contentType: application/json
      payload:
        limit: $inputs.limit
        start_time: $inputs.startTime
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      cursor: $response.body#/cursor
      hasMore: $response.body#/has_more
      items: $response.body#/items
  - stepId: nextPage
    description: >-
      Fetch the next page of audit events by submitting the cursor returned by
      the previous response.
    operationId: listAuditEventsV2
    requestBody:
      contentType: application/json
      payload:
        cursor: $steps.openFeed.outputs.cursor
    successCriteria:
    - condition: $statusCode == 200
    outputs:
      cursor: $response.body#/cursor
      hasMore: $response.body#/has_more
      items: $response.body#/items
  outputs:
    cursor: $steps.nextPage.outputs.cursor
    hasMore: $steps.nextPage.outputs.hasMore
    items: $steps.nextPage.outputs.items