1Password · Schema

APIRequest

Represents a record of an API request made to the Connect server.

Password ManagerPasswordsSecuritySecrets

Properties

Name	Type	Description
requestId	string	The unique identifier for the API request.
timestamp	string	When the request was made.
action	string	The HTTP method of the request.
result	string	The result status of the request.
actor	object	The actor who made the request.
resource	object	The resource that was accessed.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/1password/refs/heads/main/json-schema/1password-connect-api-request-schema.json",
  "title": "APIRequest",
  "description": "Represents a record of an API request made to the Connect server.",
  "type": "object",
  "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."
        }
      }
    }
  }
}