C1

C1 System Log API

The System Log API from C1 — 1 operation(s) for system log.

OpenAPI Specification

c1-system-log-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  description: The ConductorOne API is a HTTP API for managing ConductorOne resources.
  title: ConductorOne Access Conflict System Log 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
paths:
  /api/v1/systemlog/events:
    post:
      description: "ListEvents pulls Events from the ConductorOne system.\n\n This endpoint should be used to synchorize the\n system log events to external systems."
      operationId: c1.api.systemlog.v1.SystemLogService.ListEvents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c1.api.systemlog.v1.SystemLogServiceListEventsRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c1.api.systemlog.v1.SystemLogServiceListEventsResponse'
          description: Successful response
      summary: List Events
      tags:
      - System Log
      x-speakeasy-group: SystemLog
      x-speakeasy-name-override: ListEvents
components:
  schemas:
    c1.api.systemlog.v1.SystemLogServiceListEventsResponse:
      description: The SystemLogServiceListEventsResponse 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: System Log Service List Events Response
      type: object
      x-speakeasy-name-override: SystemLogServiceListEventsResponse
    c1.api.systemlog.v1.SystemLogServiceListEventsRequest:
      description: The SystemLogServiceListEventsRequest message.
      properties:
        pageSize:
          description: The pageSize field.
          format: int32
          readOnly: false
          type: integer
        pageToken:
          description: The pageToken field.
          readOnly: false
          type: string
        since:
          format: date-time
          readOnly: false
          type: string
        sinceEventUid:
          description: The sinceEventUid field.
          readOnly: false
          type: string
        sortDirection:
          description: The sortDirection field.
          enum:
          - SORT_DIRECTION_UNSPECIFIED
          - SORT_DIRECTION_ASC
          - SORT_DIRECTION_DESC
          readOnly: false
          type: string
          x-speakeasy-unknown-values: allow
        until:
          format: date-time
          readOnly: false
          type: string
      title: System Log Service List Events Request
      type: object
      x-speakeasy-name-override: SystemLogServiceListEventsRequest
  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