Get the caller's end-user profile
POST/api/v1/enduser/get
Returns the caller's full end-user record — identity claims sourced from the identity provider, profile settings the user has set, and lifecycle timestamps.
A user with no profile is not a 404
If no row exists yet, the call still succeeds and returns an empty endUser object. Treat "no profile yet" and "profile with no overrides" identically — do not branch on the difference when choosing settings. Treat the missing profile as an absent record; default-valued fields alone do not prove that an account exists or that deletion completed.
The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.
Use this in a guide: Build an agent preferences screen
Request
Responses
- 200
Profile returned (possibly empty if no row exists yet)
Read the end user selected by authentication; no user identifier is accepted in this body.
Section ID: DOC-CP-identity-access-api-getEndUser#example-end-users-getEndUser-request
Request example
{}
Illustrative response shape; omitted default fields and actual outcomes depend on the operation.
Section ID: DOC-CP-identity-access-api-getEndUser#example-end-users-getEndUser-response
Response example
{
"endUser": {
"subject": "example",
"tenantId": "example_123",
"issuer": "example",
"projectId": "example_123",
"email": "user@example.com",
"emailVerified": true,
"name": "example",
"givenName": "example",
"familyName": "example",
"preferredUsername": "example",
"picture": "example",
"phoneNumber": "example",
"phoneNumberVerified": true,
"signInProvider": "example_123",
"authMethod": "example",
"locale": "en-US",
"zoneinfo": "example",
"customClaims": {},
"location": {
"latitude": 1,
"longitude": 1,
"city": "example",
"timezone": "example"
},
"localeOverride": "en-US",
"defaultGenerationConfig": {
"model": "example",
"models": [
"example"
],
"systemPrompt": "Example text",
"transforms": [
"example"
],
"temperature": 1,
"topP": 1,
"maxOutputTokens": 1,
"frequencyPenalty": 1,
"presencePenalty": 1,
"stopSequences": [
"example"
],
"seed": "1",
"allowParallelToolCalls": true,
"topK": 1,
"repetitionPenalty": 1,
"topLogprobs": 1,
"minP": 1,
"topA": 1,
"user": "example",
"modalities": [
"MODALITY_TEXT"
],
"languagePreference": "en-US",
"requestTimeoutSeconds": 1,
"clearTools": true
},
"metadata": {},
"firstSeenAt": "2026-09-16T12:00:00Z",
"lastSeenAt": "2026-09-16T12:00:00Z",
"updatedAt": "2026-09-16T12:00:00Z",
"createdAt": "2026-09-16T12:00:00Z"
}
}
Illustrative response for 1. Load the saved settings and account defaults. Replace example resource identifiers with your own authorized values.
Section ID: DOC-CP-identity-access-api-getEndUser#example-cookbook-core-platform-identity-access-end-users-json-01-response
Response example
{
"endUser": {
"subject": "user_123",
"tenantId": "tenant_abc",
"email": "jane@example.com",
"emailVerified": true,
"name": "Jane Doe",
"givenName": "Jane",
"picture": "https://…",
"signInProvider": "google.com",
"locale": "en-US",
"zoneinfo": "Europe/London",
"location": {
"latitude": 51.5072,
"longitude": -0.1276,
"timezone": "Europe/London",
"updatedAt": "2026-08-14T09:31:02Z"
},
"localeOverride": "es-MX",
"defaultGenerationConfig": {
"model": "google/gemini-3.6-flash",
"temperature": 0.4,
"languagePreference": "es"
},
"metadata": {
"preferredView": "compact"
},
"firstSeenAt": "2026-01-14T09:12:00Z",
"lastSeenAt": "2026-08-14T09:30:58Z",
"updatedAt": "2026-08-14T09:31:02Z",
"createdAt": "2026-01-14T09:12:00Z"
}
}
Document ID: DOC-CP-identity-access-api-getEndUser. Section identities and revisions.
| Section | Stable reference |
|---|---|
| Get the caller's end-user profile | DOC-CP-identity-access-api-getEndUser#overview |
| Request | DOC-CP-identity-access-api-getEndUser#request |
| Responses | DOC-CP-identity-access-api-getEndUser#responses |