EndUserState

Captured identity claims and editable profile values for a tenant's end user. Identity claims are copied from the verified token and are read-only through the profile update operations. Location, locale overrides, generation preferences and application metadata are set through their corresponding profile update operations.

Usage profiles

Usage	Fields and validation
In responses	View fields

In responses

API JSON uses JSON field names (camelCase).

Field	Type	Presence	Meaning
subject	string	Optional	Subject claim identifying the end user within the identity provider.
tenantId	string	Optional	Identifier of the tenant that owns or scopes this record.
issuer	string	Optional	OIDC issuer identifying the identity provider.
projectId	string	Optional	Identifier of the project within the tenant that scopes this record.
email	string	Optional	Email address received from the identity provider.
emailVerified	boolean	Optional	Whether the identity provider marked the email address as verified.
name	string	Optional	Full name received from the identity provider.
givenName	string	Optional	Given-name claim received from the identity provider.
familyName	string	Optional	Family-name claim received from the identity provider.
preferredUsername	string	Optional	Preferred username claim received from the identity provider.
picture	string	Optional	Profile picture URL received from the identity provider.
phoneNumber	string	Optional	Telephone number received from the identity provider.
phoneNumberVerified	boolean	Optional	Whether the identity provider marked the telephone number as verified.
signInProvider	string	Optional	Sign-in provider recorded with the captured identity.
authMethod	string	Optional	Authentication method recorded with the captured identity.
locale	string	Optional	Locale preference associated with the user or subscriber. IdP-sourced default (not the override).
zoneinfo	string	Optional	Time zone claim received from the identity provider. IdP-sourced default.
customClaims	Map from string to string	Optional	Additional identity claims stored as string key-value pairs.
location	Location	Optional	Coordinates and derived location metadata selected by the end user.
localeOverride	string	Optional	Locale explicitly selected by the end user. When set, takes precedence over the identity provider's locale; when empty, the identity-provider locale is used.
defaultGenerationConfig	GenerationConfig	Optional	Default model generation settings associated with the end-user profile.
metadata	Map from string to string	Optional	Application-defined key-value metadata associated with the end user.
firstSeenAt	string (date-time)	Optional	Time the end-user identity was first captured.
lastSeenAt	string (date-time)	Optional	Time the end user's identity was most recently observed.
updatedAt	string (date-time)	Optional	Time this record was most recently updated.
createdAt	string (date-time)	Optional	Time this record was created.

Where used

Reference	Relationship
Get the caller's end-user profile	POST /api/v1/enduser/get

Download the public reference contract.

• end-users OpenAPI

Document: DOC-API-MODEL-end-user-state.