1Password · JSON Structure

1Password Connect Api Request Structure

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

Type: object Properties: 6
Password ManagerPasswordsSecuritySecrets

APIRequest is a JSON Structure definition published by 1Password, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

requestId timestamp action result actor resource

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/1password/refs/heads/main/json-structure/1password-connect-api-request-structure.json",
  "name": "APIRequest",
  "description": "Represents a record of an API request made to the Connect server.",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "uuid",
      "description": "The unique identifier for the API request."
    },
    "timestamp": {
      "type": "datetime",
      "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": "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": "uuid",
              "description": "The unique identifier of the item."
            }
          }
        },
        "itemVersion": {
          "type": "int32",
          "description": "The version of the item."
        }
      }
    }
  }
}