1Password · Schema

Field

Represents a field within an item that stores a value such as a username, password, or other data.

Password ManagerPasswordsSecuritySecrets

Properties

Name Type Description
id string The unique identifier for the field.
section object
type string The type of the field.
purpose string The purpose of the field, indicating its role within the item.
label string The human-readable label for the field.
value string The value stored in the field.
generate boolean Whether the field value should be auto-generated.
entropy number The entropy (strength) of the generated value.
recipe object
View JSON Schema on GitHub

JSON Schema

1password-connect-field-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/1password/refs/heads/main/json-schema/1password-connect-field-schema.json",
  "title": "Field",
  "description": "Represents a field within an item that stores a value such as a username, password, or other data.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the field."
    },
    "section": {
      "$ref": "#/components/schemas/SectionRef"
    },
    "type": {
      "type": "string",
      "description": "The type of the field.",
      "enum": [
        "STRING",
        "EMAIL",
        "CONCEALED",
        "URL",
        "TOTP",
        "DATE",
        "MONTH_YEAR",
        "MENU"
      ]
    },
    "purpose": {
      "type": "string",
      "description": "The purpose of the field, indicating its role within the item.",
      "enum": [
        "USERNAME",
        "PASSWORD",
        "NOTES"
      ]
    },
    "label": {
      "type": "string",
      "description": "The human-readable label for the field."
    },
    "value": {
      "type": "string",
      "description": "The value stored in the field."
    },
    "generate": {
      "type": "boolean",
      "description": "Whether the field value should be auto-generated."
    },
    "entropy": {
      "type": "number",
      "description": "The entropy (strength) of the generated value."
    },
    "recipe": {
      "$ref": "#/components/schemas/GeneratorRecipe"
    }
  }
}