Section ID:
DOC-API-MODEL-schema-1l1et4gp2i#overview
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.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-subjectSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-subjectsubject | string | Optional | Subject claim identifying the end user within the identity provider. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-tenantidSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-tenantidtenantId | string | Optional | Identifier of the tenant that owns or scopes this record. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-issuerSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-issuerissuer | string | Optional | OIDC issuer identifying the identity provider. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-projectidSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-projectidprojectId | string | Optional | Identifier of the project within the tenant that scopes this record. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-emailSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-emailemail | string | Optional | Email address received from the identity provider. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-emailverifiedSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-emailverifiedemailVerified | boolean | Optional | Whether the identity provider marked the email address as verified. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-nameSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-namename | string | Optional | Full name received from the identity provider. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-givennameSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-givennamegivenName | string | Optional | Given-name claim received from the identity provider. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-familynameSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-familynamefamilyName | string | Optional | Family-name claim received from the identity provider. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-preferredusernameSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-preferredusernamepreferredUsername | string | Optional | Preferred username claim received from the identity provider. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-pictureSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-picturepicture | string | Optional | Profile picture URL received from the identity provider. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-phonenumberSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-phonenumberphoneNumber | string | Optional | Telephone number received from the identity provider. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-phonenumberverifiedSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-phonenumberverifiedphoneNumberVerified | boolean | Optional | Whether the identity provider marked the telephone number as verified. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-signinproviderSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-signinprovidersignInProvider | string | Optional | Sign-in provider recorded with the captured identity. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-authmethodSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-authmethodauthMethod | string | Optional | Authentication method recorded with the captured identity. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-localeSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-localelocale | string | Optional | Locale preference associated with the user or subscriber. IdP-sourced default (not the override). |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-zoneinfoSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-zoneinfozoneinfo | string | Optional | Time zone claim received from the identity provider. IdP-sourced default. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-customclaimsSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-customclaimscustomClaims | Map from string to string | Optional | Additional identity claims represented as string key-value pairs. The current end-user store does not populate this field. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-locationSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-locationlocation | Location | Optional | Coordinates and derived location metadata selected by the end user. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-localeoverrideSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-localeoverridelocaleOverride | 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. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-defaultgenerationconfigSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-defaultgenerationconfigdefaultGenerationConfig | GenerationConfig | Optional | Default model generation settings associated with the end-user profile. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-metadataSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-metadatametadata | Map from string to string | Optional | Application-defined key-value metadata associated with the end user. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-firstseenatSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-firstseenatfirstSeenAt | string (date-time) | Optional | Time the end-user identity was first captured. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-lastseenatSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-lastseenatlastSeenAt | string (date-time) | Optional | Time the end user's identity was most recently observed. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-updatedatSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-updatedatupdatedAt | string (date-time) | Optional | Time this record was most recently updated. |
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#field-createdatSection ID: DOC-API-MODEL-schema-1l1et4gp2i#response-field-createdatcreatedAt | string (date-time) | Optional | Time this record was created. |
Where used
Section ID: DOC-API-MODEL-schema-1l1et4gp2i#where-used
| Reference | Relationship |
|---|---|
| Get the caller's end-user profile | POST /api/v1/enduser/get |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1l1et4gp2i