Identity

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/letta/main/json-schema/letta-identity-schema.json",
  "title": "Identity",
  "description": "JSON Schema for the Letta Identity entity, extracted from the Letta OpenAPI 1.0.0 spec.",
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^identity-[a-fA-F0-9]{8}",
      "title": "Id",
      "description": "The human-friendly ID of the Identity",
      "examples": [
        "identity-123e4567-e89b-12d3-a456-426614174000"
      ]
    },
    "identifier_key": {
      "type": "string",
      "title": "Identifier Key",
      "description": "External, user-generated identifier key of the identity."
    },
    "name": {
      "type": "string",
      "title": "Name",
      "description": "The name of the identity."
    },
    "identity_type": {
      "$ref": "#/$defs/IdentityType"
    },
    "project_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Project Id",
      "description": "The project id of the identity, if applicable."
    },
    "agent_ids": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Agent Ids",
      "description": "The IDs of the agents associated with the identity.",
      "deprecated": true
    },
    "block_ids": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "title": "Block Ids",
      "description": "The IDs of the blocks associated with the identity.",
      "deprecated": true
    },
    "properties": {
      "items": {
        "$ref": "#/$defs/IdentityProperty"
      },
      "type": "array",
      "title": "Properties",
      "description": "List of properties associated with the identity"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "identifier_key",
    "name",
    "identity_type",
    "agent_ids",
    "block_ids"
  ],
  "$defs": {
    "IdentityType": {
      "type": "string",
      "enum": [
        "org",
        "user",
        "other"
      ],
      "title": "IdentityType",
      "description": "Enum to represent the type of the identity."
    },
    "IdentityProperty": {
      "properties": {
        "key": {
          "type": "string",
          "title": "Key",
          "description": "The key of the property"
        },
        "value": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "integer"
            },
            {
              "type": "number"
            },
            {
              "type": "boolean"
            },
            {
              "additionalProperties": true,
              "type": "object"
            }
          ],
          "title": "Value",
          "description": "The value of the property"
        },
        "type": {
          "$ref": "#/$defs/IdentityPropertyType"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "key",
        "value",
        "type"
      ],
      "title": "IdentityProperty",
      "description": "A property of an identity"
    },
    "IdentityPropertyType": {
      "type": "string",
      "enum": [
        "string",
        "number",
        "boolean",
        "json"
      ],
      "title": "IdentityPropertyType",
      "description": "Enum to represent the type of the identity property."
    }
  }
}