ConductorOne System Log Exporter API

openapi: 3.1.0
info:
  description: The ConductorOne API is a HTTP API for managing ConductorOne resources.
  title: ConductorOne Access Conflict System Log Exporter API
  version: 0.1.0-alpha
servers:
- description: The ConductorOne API server for the current tenant.
  url: https://{tenantDomain}.conductor.one
  variables:
    tenantDomain:
      default: example
      description: The domain of the tenant to use for this request.
security:
- bearerAuth: []
  oauth: []
tags:
- name: System Log Exporter
paths:
  /api/v1/search/systemlog/exports:
    post:
      description: Invokes the c1.api.systemlog.v1.ExportsSearchService.Search method.
      operationId: c1.api.systemlog.v1.ExportsSearchService.Search
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.systemlog.v1.ExportsSearchServiceSearchRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.systemlog.v1.ExportsSearchServiceSearchResponse'
          description: Successful response
      summary: Search
      tags:
      - System Log Exporter
      x-speakeasy-group: ExportsSearch
      x-speakeasy-name-override: Search
  /api/v1/systemlog/exports:
    get:
      description: List Exports.
      operationId: c1.api.systemlog.v1.ExportService.List
      parameters:
      - in: query
        name: page_size
        schema:
          description: The pageSize field.
          format: int32
          readOnly: false
          type: integer
      - in: query
        name: page_token
        schema:
          description: The pageToken field.
          readOnly: false
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.systemlog.v1.ExportServiceListResponse'
          description: Successful response
      summary: List
      tags:
      - System Log Exporter
      x-speakeasy-group: Export
      x-speakeasy-name-override: List
    post:
      description: Create a system log export.
      operationId: c1.api.systemlog.v1.ExportService.Create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.systemlog.v1.ExportServiceCreateRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.systemlog.v1.ExportServiceCreateResponse'
          description: Successful response
      summary: Create
      tags:
      - System Log Exporter
      x-speakeasy-group: Export
      x-speakeasy-name-override: Create
  /api/v1/systemlog/exports/{export_id}:
    delete:
      description: Delete a policy by ID.
      operationId: c1.api.systemlog.v1.ExportService.Delete
      parameters:
      - in: path
        name: export_id
        required: true
        schema:
          description: The exportId field.
          readOnly: false
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.systemlog.v1.ExportServiceDeleteRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.systemlog.v1.ExportServiceDeleteResponse'
          description: Successful response
      summary: Delete
      tags:
      - System Log Exporter
      x-speakeasy-group: Export
      x-speakeasy-name-override: Delete
    get:
      description: Get a system log export by ID
      operationId: c1.api.systemlog.v1.ExportService.Get
      parameters:
      - in: path
        name: export_id
        required: true
        schema:
          description: The exportId field.
          readOnly: false
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.systemlog.v1.ExportServiceGetResponse'
          description: The ExportServiceGetResponse message contains the system log exporter object.
      summary: Get
      tags:
      - System Log Exporter
      x-speakeasy-group: Export
      x-speakeasy-name-override: Get
    post:
      description: Update a system log export by providing a policy object and an update mask.
      operationId: c1.api.systemlog.v1.ExportService.Update
      parameters:
      - in: path
        name: export_id
        required: true
        schema:
          description: The exportId field.
          readOnly: true
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.systemlog.v1.ExportServiceUpdateRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.systemlog.v1.ExportServiceUpdateResponse'
          description: Successful response
      summary: Update
      tags:
      - System Log Exporter
      x-speakeasy-group: Export
      x-speakeasy-name-override: Update
  /api/v1/systemlog/exports/{export_id}/events:
    post:
      description: Invokes the c1.api.systemlog.v1.ExportService.ListEvents method.
      operationId: c1.api.systemlog.v1.ExportService.ListEvents
      parameters:
      - in: path
        name: export_id
        required: true
        schema:
          description: The exportId field.
          readOnly: false
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.systemlog.v1.ExportServiceListEventsRequestInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.systemlog.v1.ExportServiceListEventsResponse'
          description: Successful response
      summary: List Events
      tags:
      - System Log Exporter
      x-speakeasy-group: Export
      x-speakeasy-name-override: ListEvents
components:
  schemas:
    c1.api.systemlog.v1.ExportServiceDeleteResponse:
      description: The ExportServiceDeleteResponse message.
      title: Export Service Delete Response
      type: object
      x-speakeasy-name-override: ExportServiceDeleteResponse
    c1.api.systemlog.v1.ExporterRef:
      description: The ExporterRef message.
      properties:
        exportId:
          description: The exportId field.
          readOnly: false
          type: string
      title: Exporter Ref
      type: object
      x-speakeasy-name-override: ExporterRef
    c1.api.systemlog.v1.ExportServiceDeleteRequestInput:
      description: The ExportServiceDeleteRequest message.
      title: Export Service Delete Request
      type: object
      x-speakeasy-name-override: ExportServiceDeleteRequest
    c1.api.systemlog.v1.ExportServiceCreateRequest:
      description: "The ExportServiceCreateRequest message is used to create a new system log exporter.\n\nThis message contains a oneof named export_to. Only a single field of the following list may be set at a time:\n  - datasource\n"
      properties:
        datasource:
          $ref: '#/components/schemas/c1.api.systemlog.v1.ExportToDatasource'
        displayName:
          description: The display name of the new policy.
          readOnly: false
          type: string
      title: Export Service Create Request
      type: object
      x-speakeasy-name-override: ExportServiceCreateRequest
    c1.api.systemlog.v1.ExportServiceCreateResponse:
      description: The ExportServiceCreateResponse message.
      properties:
        exporter:
          $ref: '#/components/schemas/c1.api.systemlog.v1.Exporter'
      title: Export Service Create Response
      type: object
      x-speakeasy-name-override: ExportServiceCreateResponse
    c1.api.systemlog.v1.ExportServiceListEventsRequestInput:
      description: The ExportServiceListEventsRequest message.
      properties:
        pageSize:
          description: The pageSize field.
          format: int32
          readOnly: false
          type: integer
        pageToken:
          description: The pageToken field.
          readOnly: false
          type: string
      title: Export Service List Events Request
      type: object
      x-speakeasy-name-override: ExportServiceListEventsRequest
    c1.api.systemlog.v1.ExportsSearchServiceSearchResponse:
      description: The ExportsSearchServiceSearchResponse message.
      properties:
        list:
          description: The list field.
          items:
            $ref: '#/components/schemas/c1.api.systemlog.v1.Exporter'
          nullable: true
          readOnly: false
          type: array
        nextPageToken:
          description: The nextPageToken field.
          readOnly: false
          type: string
      title: Exports Search Service Search Response
      type: object
      x-speakeasy-name-override: ExportsSearchServiceSearchResponse
    c1.api.systemlog.v1.ExportsSearchServiceSearchRequest:
      description: The ExportsSearchServiceSearchRequest message.
      properties:
        displayName:
          description: Search for system log exporters with a case insensitive match on the display name.
          readOnly: false
          type: string
        pageSize:
          description: The pageSize field.
          format: int32
          readOnly: false
          type: integer
        pageToken:
          description: The pageToken field.
          readOnly: false
          type: string
        query:
          description: The query field.
          readOnly: false
          type: string
        refs:
          description: The refs field.
          items:
            $ref: '#/components/schemas/c1.api.systemlog.v1.ExporterRef'
          nullable: true
          readOnly: false
          type: array
      title: Exports Search Service Search Request
      type: object
      x-speakeasy-name-override: ExportsSearchServiceSearchRequest
    c1.api.systemlog.v1.ExportServiceUpdateResponse:
      description: The ExportServiceUpdateResponse message.
      properties:
        exporter:
          $ref: '#/components/schemas/c1.api.systemlog.v1.Exporter'
      title: Export Service Update Response
      type: object
      x-speakeasy-name-override: ExportServiceUpdateResponse
    c1.api.systemlog.v1.ExportToDatasource:
      description: The ExportToDatasource message.
      nullable: true
      properties:
        datasourceId:
          description: The datasourceId field.
          readOnly: false
          type: string
        format:
          description: The format field.
          enum:
          - EXPORT_FORMAT_UNSPECIFIED
          - EXPORT_FORMAT_OCSF_JSON_ZSTD
          - EXPORT_FORMAT_OCSF_JSON_GZIP
          readOnly: false
          type: string
          x-speakeasy-unknown-values: allow
        prefix:
          description: The prefix field.
          readOnly: false
          type: string
      title: Export To Datasource
      type: object
      x-speakeasy-name-override: ExportToDatasource
    c1.api.systemlog.v1.ExportServiceUpdateRequestInput:
      description: The ExportServiceUpdateRequest message.
      properties:
        exporter:
          $ref: '#/components/schemas/c1.api.systemlog.v1.Exporter'
        updateMask:
          nullable: true
          readOnly: false
          type: string
      title: Export Service Update Request
      type: object
      x-speakeasy-name-override: ExportServiceUpdateRequest
    c1.api.systemlog.v1.Exporter:
      description: "The Exporter message.\n\nThis message contains a oneof named export_to. Only a single field of the following list may be set at a time:\n  - datasource\n"
      properties:
        createdAt:
          format: date-time
          readOnly: true
          type: string
        datasource:
          $ref: '#/components/schemas/c1.api.systemlog.v1.ExportToDatasource'
        deletedAt:
          format: date-time
          readOnly: true
          type: string
        displayName:
          description: The displayName field.
          readOnly: false
          type: string
        exportId:
          description: The exportId field.
          readOnly: true
          type: string
        state:
          description: The state field.
          enum:
          - EXPORT_STATE_UNSPECIFIED
          - EXPORT_STATE_EXPORTING
          - EXPORT_STATE_WAITING
          - EXPORT_STATE_ERROR
          readOnly: true
          type: string
          x-speakeasy-unknown-values: allow
        updatedAt:
          format: date-time
          readOnly: true
          type: string
        watermarkEventId:
          description: we've synchorized this far
          readOnly: true
          type: string
      title: Exporter
      type: object
      x-speakeasy-name-override: Exporter
    c1.api.systemlog.v1.ExportServiceListEventsResponse:
      description: The ExportServiceListEventsResponse message.
      properties:
        list:
          description: List contains an array of JSON OCSF events.
          items:
            additionalProperties: true
            readOnly: false
            type: object
          nullable: true
          readOnly: false
          type: array
        nextPageToken:
          description: The nextPageToken field.
          readOnly: false
          type: string
      title: Export Service List Events Response
      type: object
      x-speakeasy-name-override: ExportServiceListEventsResponse
    c1.api.systemlog.v1.ExportServiceGetResponse:
      description: The ExportServiceGetResponse message contains the system log exporter object.
      properties:
        exporter:
          $ref: '#/components/schemas/c1.api.systemlog.v1.Exporter'
      title: Export Service Get Response
      type: object
      x-speakeasy-name-override: ExportServiceGetResponse
    c1.api.systemlog.v1.ExportServiceListResponse:
      description: The ExportServiceListResponse message.
      properties:
        list:
          description: The list of results containing up to X results, where X is the page size defined in the request
          items:
            $ref: '#/components/schemas/c1.api.systemlog.v1.Exporter'
          nullable: true
          readOnly: false
          type: array
        nextPageToken:
          description: The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.
          readOnly: false
          type: string
      title: Export Service List Response
      type: object
      x-speakeasy-name-override: ExportServiceListResponse
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
    oauth:
      description: '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()](https://github.com/ConductorOne/conductorone-sdk-go/blob/3375fe7c0126d17e7ec4e711693dee7b791023aa/token_source.go#L101-L187) function.'
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /auth/v1/token
      type: oauth2