User Identity
User Identity contains personally identifiable information (PII) separated from the user record for privacy compliance. It can be deleted independently while preserving the user reference.
Schema
interface UserIdentity {
id: string; // User ID (uid...)
given_name: string | null;
family_name: string | null;
display_name: string | null;
avatar_url: string | null;
locale: string | null; // e.g., "en-US"
timezone: string | null; // e.g., "America/New_York"
preferred_language: string | null;
external_id: string | null;
}
Properties
| Property |
Type |
Description |
id |
string |
User this identity belongs to |
given_name |
string? |
First name |
family_name |
string? |
Last name |
display_name |
string? |
Preferred display name |
avatar_url |
string? |
Profile picture URL |
locale |
string? |
Locale preference (BCP 47) |
timezone |
string? |
IANA timezone |
preferred_language |
string? |
Language preference |
external_id |
string? |
External system identifier |
Privacy Design
User (Permanent) Identity (Deletable)
┌─────────────┐ ┌─────────────────┐
│ id │◄────────▶│ id │
│ application │ │ given_name │
│ status │ │ family_name │
└─────────────┘ │ display_name │
│ ... │
└─────────────────┘
GDPR Operations
| Operation |
Effect |
| DELETE |
Removes all PII, preserves user reference |
| POST (recreate) |
Restores identity after deletion |
Example
{
"id": "uid_2kHfPZcN9xW4mE8RtY7vB",
"given_name": "Jane",
"family_name": "Smith",
"display_name": "Jane S.",
"avatar_url": "https://example.com/avatar.jpg",
"locale": "en-US",
"timezone": "America/New_York",
"preferred_language": "en",
"external_id": "crm_123"
}