UserstoreColumn

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/userclouds/json-schema/userclouds-userstore-column-schema.json",
  "title": "UserstoreColumn",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/userstore.yaml#/components/schemas/UserstoreColumn",
  "properties": {
    "access_policy": {
      "$ref": "#/$defs/UserstoreResourceID"
    },
    "constraints": {
      "$ref": "#/$defs/UserstoreColumnConstraints"
    },
    "data_type": {
      "$ref": "#/$defs/UserstoreResourceID"
    },
    "default_token_access_policy": {
      "$ref": "#/$defs/UserstoreResourceID"
    },
    "default_transformer": {
      "$ref": "#/$defs/UserstoreResourceID"
    },
    "default_value": {
      "type": "string"
    },
    "id": {
      "$ref": "#/$defs/UuidUUID"
    },
    "index_type": {
      "$ref": "#/$defs/UserstoreColumnIndexType"
    },
    "is_array": {
      "type": "boolean"
    },
    "is_system": {
      "description": "Whether this column is a system column. System columns cannot be deleted or modified. This property cannot be changed.",
      "type": "boolean"
    },
    "name": {
      "type": "string"
    },
    "search_indexed": {
      "type": "boolean"
    },
    "table": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "data_type",
    "is_array",
    "index_type"
  ],
  "type": "object",
  "$defs": {
    "UserstoreColumnConstraints": {
      "properties": {
        "fields": {
          "description": "The set of fields associated with a column of type composite. Fields cannot be specified if the column type is not composite.",
          "items": {
            "$ref": "#/$defs/UserstoreColumnField"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "immutable_required": {
          "description": "Can be enabled when unique_id_required is enabled. If true, values for the associated column cannot be modified, but can be added or removed.",
          "type": "boolean"
        },
        "partial_updates": {
          "description": "Can be enabled for array columns that have UniqueRequired or UniqueIDRequired enabled. When enabled, a mutation request will update the specified subset of values for the associated column.",
          "type": "boolean"
        },
        "unique_id_required": {
          "description": "Can be enabled for column type composite or address. If true, each value for the associated column must have a unique string ID, which can either be provided or generated by backend.",
          "type": "boolean"
        },
        "unique_required": {
          "description": "If true, each value for the associated column must be unique for the user. This is primarily useful for array columns.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "UserstoreColumnField": {
      "properties": {
        "camel_case_name": {
          "description": "Read-only camel-case version of field name, with underscores stripped out. (ex. IDField1)",
          "type": "string"
        },
        "ignore_for_uniqueness": {
          "description": "If true, field value will be ignored when comparing two composite value for a uniqueness check.",
          "type": "boolean"
        },
        "name": {
          "description": "Each part of name must be capitalized or all-caps, separated by underscores. Names may contain alphanumeric characters, and the first part must start with a letter, while other parts may start with a number. (ex. ID_Field_1)",
          "type": "string"
        },
        "required": {
          "description": "Whether a value must be specified for the field.",
          "type": "boolean"
        },
        "struct_name": {
          "description": "Read-only snake-case version of field name, with all letters lowercase. (ex. id_field_1)",
          "type": "string"
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "type",
        "name"
      ],
      "type": "object"
    },
    "UserstoreColumnIndexType": {
      "enum": [
        "indexed",
        "none",
        "unique"
      ],
      "type": "string"
    },
    "UserstoreResourceID": {
      "properties": {
        "id": {
          "$ref": "#/$defs/UuidUUID"
        },
        "name": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "UuidUUID": {
      "format": "uuid",
      "type": "string"
    }
  }
}