1Password Activity API

openapi: 3.2.0
info:
  title: 1Password Connect Server Activity API
  description: The 1Password Connect Server API provides secure access to 1Password items and vaults in your company's apps and cloud infrastructure through a private REST API. Connect Servers bridge the gap between 1Password and your infrastructure by enabling programmatic access to secrets stored in shared vaults. You can create, read, update, and delete items, manage vaults, and retrieve files attached to items.
  version: 1.8.1
  contact:
    name: 1Password Support
    url: https://support.1password.com/
  termsOfService: https://1password.com/legal/terms-of-service/
  license:
    name: MIT
    url: https://github.com/1Password/connect/blob/main/LICENSE
servers:
- url: http://localhost:8080
  description: Local Connect Server (default port 8080)
security:
- bearerAuth: []
tags:
- name: Activity
  description: Operations for listing API requests made to the Connect server.
paths:
  /v1/activity:
    get:
      operationId: listActivity
      summary: 1Password List API Activity
      description: Returns a list of API requests that have been made to the Connect server. Each activity entry includes the request method, path, timestamp, and result status.
      tags:
      - Activity
      parameters:
      - name: limit
        in: query
        description: Maximum number of activity records to return.
        required: false
        schema:
          type: integer
          default: 50
      - name: offset
        in: query
        description: Number of activity records to skip before returning results.
        required: false
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: Successfully retrieved activity log
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    VaultRef:
      type: object
      description: A reference to a vault.
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the referenced vault.
    Error:
      type: object
      description: Represents an error response from the Connect server.
      properties:
        status:
          type: integer
          description: The HTTP status code.
        message:
          type: string
          description: A human-readable error message.
    APIRequest:
      type: object
      description: Represents a record of an API request made to the Connect server.
      properties:
        requestId:
          type: string
          format: uuid
          description: The unique identifier for the API request.
        timestamp:
          type: string
          format: date-time
          description: When the request was made.
        action:
          type: string
          description: The HTTP method of the request.
        result:
          type: string
          description: The result status of the request.
          enum:
          - SUCCESS
          - DENY
        actor:
          type: object
          description: The actor who made the request.
          properties:
            id:
              type: string
              format: uuid
              description: The unique identifier of the actor.
            account:
              type: string
              description: The account associated with the actor.
            jti:
              type: string
              description: The JWT token identifier.
            userAgent:
              type: string
              description: The user agent string of the client.
            requestIp:
              type: string
              description: The IP address of the client.
        resource:
          type: object
          description: The resource that was accessed.
          properties:
            type:
              type: string
              description: The type of resource.
            vault:
              $ref: '#/components/schemas/VaultRef'
            item:
              type: object
              properties:
                id:
                  type: string
                  format: uuid
                  description: The unique identifier of the item.
            itemVersion:
              type: integer
              description: The version of the item.
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: A Connect server access token generated from 1Password. Each request must include this token in the Authorization header.
externalDocs:
  description: 1Password Connect Server API Reference
  url: https://developer.1password.com/docs/connect/api-reference/