Overview

The Profile Schema is a tenant configuration that defines the structure, presentation, and forms for user profiles. This documentation explains how to read and understand an existing Profile Schema configuration.

Understanding the Schema Structure

A Profile Schema consists of three main sections:

• Components: Defines the available profile field types and their configurations
• Presentation: Defines how components are grouped and displayed in the profile view
• Forms: Defines the structure of edit and filter forms

Schema Structure

When reading a Profile Schema, you'll encounter the following top-level fields:

Field	Type	Required	Description
version	string	Yes	Schema version identifier
components	AnyComponent array	Yes	Array of component definitions
presentation	Group array	Yes	Grouped component references for display
forms	object	Yes	Form definitions
forms.edit	FormSchema	Yes	Edit form schema
forms.filter	FormSchema	No	Filter form schema (optional)

Component Types

The Profile Schema supports four component types. Each component type has a kind field that identifies its type:

Component Type	Description	Common Use Cases
text	Text input for string values	Names, descriptions, notes
choice	Selection from a list of choices	Gender, categories, preferences
date	Date and time input	Birth date, registration date
address	Address information (continent, country, etc.)	User addresses, locations

Documentation

• Components
• Text Component
• Choice Component
• Date Component
• Address Component
• Presentation
• Forms