Configure Identity Pool user attributes

Schemas standardize user data collection across your organization, ensuring consistent required fields and validation rules for all Identity Pools.

💡 Why this matters
Standardized schemas reduce data inconsistencies, improve user onboarding, and ensure compliance with data requirements.

Create a user attribute schema

1. Go to Tenant settings > Identity Pools > Schemas

2. Click Create Schema and save it with a unique name

3. Open the schema and go to the Schema tab

4. Configure the schema using JSON format with these key properties:

   Property	Purpose	Example
   properties	Defines user data fields	"given_name": {"type": "string"}
   description	Schema description for forms	"sample user data schema"
   type	Always set to "object"	"object"
   required	Lists mandatory fields	["given_name", "family_name"]

5. Add custom fields by modifying the schema:

   {
     "properties": {
       "family_name": {
         "description": "user last name",
         "type": "string",
         "minLength": 1
       },
       "given_name": {
         "description": "user first name", 
         "type": "string",
         "minLength": 1
       },
       "name": {
         "description": "user full name",
         "type": "string",
         "minLength": 1
       },
       "e-mail": {
         "description": "user e-mail",
         "type": "string",
         "minLength": 1
       },
       "custom": {
         "description": "Custom boolean field",
         "type": "boolean"
       }
     },
     "description": "sample user data schema",
     "type": "object",
     "required": [
       "family_name",
       "given_name", 
       "e-mail",
       "custom"
     ]
   }

6. Save your changes

   Verify: Schema appears in the tenant-level schemas list

Attach schema to Identity Pool

⚠️ Important
Schemas attached to Identity Pools are read-only. To modify a schema, update it at the tenant level. Changes apply across all associated Identity Pools.

1. Go to Tenant settings > Identity Pools > [Selected Identity Pool] > Schemas

2. Select the schema that aligns with your organization's policies

3. Save your changes

   Verify: Registration forms now show the configured required fields