openapi: 3.2.0
info:
  title: Boomi Data Integration Audit Events API
  description: '# Boomi Data Integration API documentation


    Welcome to the Boomi Data Integration API Documentation.'
  contact:
    name: Boomi Data Integration Documentation
    url: https://community.boomi.com/s/support
    email: support@boomi.com
  version: 1.0.0
  x-logo:
    url: https://rivery.io/wp-content/uploads/2021/08/logo.png
servers:
- url: https://api.rivery.io
  description: US
- url: https://api.eu-west-1.rivery.io
  description: EU
tags:
- name: Audit Events
  description: Listing account's audit events
paths:
  /v1/accounts/{account_id}/environments/{environment_id}/audit_events:
    get:
      tags:
      - Audit Events
      summary: List Audit Events
      description: '**Authorization scope:** `audit:list`


        **List audit events**'
      operationId: list_audit_events
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
          title: Environment Id
      - name: start_time
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
          examples:
          - '2020-01-01T12:00:00'
          title: Start Time
        description: The start UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm
      - name: end_time
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          description: The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm If end_time is supplied without start_time the start_time will be the previous day of the end_time
          examples:
          - '2020-01-01T12:00:00'
          title: End Time
        description: The end UTC date time. Time format YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SS.mmmmmm If end_time is supplied without start_time the start_time will be the previous day of the end_time
      - name: user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              type: string
          - type: 'null'
          description: A list of users id's who initiated the event
          examples:
          - 5eda28ee6b028e1ce7a2b5ed
          title: User Id
        description: A list of users id's who initiated the event
      - name: event_type
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/AuditEventTypeEnum'
          - type: 'null'
          description: A list of entity types
          examples:
          - connections
          - rivers
          - river_groups
          title: Event Type
        description: A list of entity types
      - name: entity_type
        in: query
        required: false
        schema:
          anyOf:
          - type: array
            items:
              $ref: '#/components/schemas/AuditEntityTypeEnum'
          - type: 'null'
          description: A list of event types
          examples:
          - delete
          - create
          - update
          title: Entity Type
        description: A list of event types
      - name: entity_logical_key
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: A unique logical identifier of an entity, usually the cross_id
          examples:
          - 5eda28ee6b028e1ce7a2b5ec
          title: Entity Logical Key
        description: A unique logical identifier of an entity, usually the cross_id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditEventsPaginationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/accounts/{account_id}/environments/{environment_id}/audit_events/{event_id}:
    get:
      tags:
      - Audit Events
      summary: Get Audit Event
      description: '**Authorization scope:** `audit:list`


        **Get a specific audit event by event_id.**'
      operationId: get_audit_event
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
          title: Environment Id
      - name: event_id
        in: path
        required: true
        schema:
          type: string
          description: The id of the audit event
          examples:
          - eac285a5a9ae4ada9ccd49889a651e16
          title: Event Id
        description: The id of the audit event
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditEventsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AuditEventsPaginationResponse:
      properties:
        next_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Page
          description: The next page URL
        previous_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Page
          description: The previous page URL
        items:
          items:
            $ref: '#/components/schemas/AuditEventsResponse'
          type: array
          title: Items
      type: object
      required:
      - items
      title: AuditEventsPaginationResponse
      description: Audit events pagination response
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AuditEventTypeEnum:
      type: string
      enum:
      - create
      - recover
      - delete
      - update
      - initiate_activate_river
      - initiate_disable_river
      - edit_cdc_configuration
      - delete_cdc_configuration
      title: AuditEventTypeEnum
      description: The audit events, events type
    AuditEventsResponse:
      properties:
        event_id:
          type: string
          title: Event Id
          description: The id of the audit event
          examples:
          - eac285a5a9ae4ada9ccd49889a651e16
        event_initiator:
          type: string
          title: Event Initiator
          description: Where the event was initiated
          examples:
          - UI
        event_datetime:
          type: string
          title: Event Datetime
          description: The event date time in UTC timezone
          examples:
          - '2022-08-02T13:38:44.054000'
        event_type:
          allOf:
          - $ref: '#/components/schemas/AuditEventTypeEnum'
          description: The type of the event
          examples:
          - create
        event_result_status:
          type: integer
          title: Event Result Status
          description: The status of the API request of the event
          examples:
          - 200
        event_name:
          type: string
          title: Event Name
          description: The name of the event in the following format-event_type:entity_type:additional_info
          examples:
          - update:rivers:without_version
        entity_type:
          allOf:
          - $ref: '#/components/schemas/AuditEntityTypeEnum'
          description: The type of entity that was recorded
          examples:
          - rivers
        entity_logical_key:
          type: string
          title: Entity Logical Key
          default: A unique logical identifier of an entity, usually the cross_id
          examples:
          - 5eda28ee6b028e1ce7a2b5ec
        account_id:
          type: string
          title: Account Id
          description: The account id the event originated for
          examples:
          - 5ebec4ca6b028e2da4191dde
        environment_id:
          type: string
          title: Environment Id
          description: The environment id the event originated for
          examples:
          - 5ebec4ca6b028e2da4191de1
        user_id:
          type: string
          title: User Id
          description: The user id the event originated for
          examples:
          - 60d08931f5682c0d9fa24890
        user_name:
          anyOf:
          - type: string
          - type: 'null'
          title: User Name
          description: The name of the user that originated the event
          examples:
          - Rivi Ee
        entity_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity Name
          description: The name of the event entity, this could be the name of the river, connection etc.
          examples:
          - My First River
        entity_subtype:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity Subtype
          description: The even subtype, this could be a river classification like logic or s2t rivers
          examples:
          - src_to_trgt
          - logic
        additional_info:
          anyOf:
          - type: string
          - type: 'null'
          title: Additional Info
          default: Additional information saved for the event
          examples:
          - '{"version_id": "637582d3c32287000fc1d69f"}'
      type: object
      required:
      - event_id
      - event_initiator
      - event_datetime
      - event_type
      - event_result_status
      - event_name
      - entity_type
      - account_id
      - environment_id
      - user_id
      title: AuditEventsResponse
      description: Audit events response
    AuditEntityTypeEnum:
      type: string
      enum:
      - accounts
      - connections
      - rivers
      - river_groups
      - users
      - teams
      title: AuditEntityTypeEnum
      description: The audit event entity types
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
externalDocs:
  description: Find out more about Data Integration
  url: https://help.boomi.com/docs/Atomsphere/Data_Integration/Data_Integration_Overview