Unqork Logs API

openapi: 3.2.0
info:
  version: 1.0.0
  x-logo:
    url: https://developers.unqork.io/unqork-logo.png
    backgroundColor: '#FFFFFF'
  title: Unqork Customer Logs API
  description: Unqork's customer REST API, based on open standards, allows you to set and retrieve module submission data, as well as control other aspects of your Unqork environment.
servers:
- url: https://{host}/api/1.0
  variables:
    host:
      default: env.unqork.io
      description: Environment host
security:
- OAuth2: []
tags:
- name: Logs
paths:
  /logs/audit-logs:
    get:
      tags:
      - Logs
      summary: Get Audit Logs
      operationId: listAuditLogs
      description: 'Retrieve audit logs for a given time period. The time interval between startDatetime and endDatetime must be 1 hour or less.

        ### Authorization Required:

        - Designer Administrator'
      parameters:
      - name: startDatetime
        in: query
        required: true
        description: 'An international datetime string representing the starting point of the interval to retrieve logs. The timestamp is in UTC. For example, ''2023-05-17T15:00:00.000Z'' is 15:00 / 3:00PM UTC on May 17th 2023.

          '
        schema:
          type: string
      - name: endDatetime
        in: query
        required: true
        description: 'An international datetime string representing the ending point of the interval to retrieve logs. The timestamp is in UTC. For example, ''2023-05-17T16:00:00.000Z'' is 16:00 / 4:00PM UTC on May 17th 2023.

          '
        schema:
          type: string
      responses:
        '200':
          description: JSON array containing links to log files
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAuditLogsResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      description: Error
      required:
      - code
      - message
      properties:
        code:
          description: HTTP status code
          type: integer
          format: int32
          enum:
          - 400
          - 401
          - 403
          - 404
          - 412
          - 500
        message:
          description: Error message
          type: string
    ListAuditLogsResponse:
      type: object
      properties:
        logLocations:
          type: array
          description: Array of links to audit log files.
          items:
            type: string
  securitySchemes:
    OAuth2:
      description: "The Unqork API implements the [OAuth 2.0 Client Credentials Grant](https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.4) and the [OAuth 2.0 Password Grant](https://tools.ietf.org/html/rfc6749#section-1.3.3). Access via OAuth2 Client Credentials Grant can be utilized by creating Client Credentials through the API Access Management Administration page. Access via OAuth2 Password Grant can be enabled for all users in Environment Administration. Once OAuth2 Password Grant is enabled, all Unqork users can use their Unqork username/password to retrieve an access token.\n\nIn order to utilize any of the API resources, you must first retrieve an access token by POSTing your credentials to the access token URL, e.g. using `curl`:\n```\n  $ curl -u '{clientId}:{clientSecret}' -X POST --basic https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token -d \"grant_type=client_credentials\"\n```\nOr:\n```\n  $ curl -X POST https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token -d \"grant_type=password&username={username}&password={password}\"\n```\nThis returns an \"access_token\", which you would then retain and use in any subsequent resource requests. **Access tokens expire after one hour, at which point you must retrieve a new one.** The access token should be included in a request header:\n```\n  $ curl -H \"Authorization: Bearer {access_token}\" https://xyzfinancial.unqork.io/api/1.0/{endpoint}\n```\n"
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
          scopes:
            none: N/A
        password:
          tokenUrl: https://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
          scopes:
            none: N/A