Get User Profile (Human)
Get basic information like first_name and last_name of a user.
Path Parameters
- userId string required
Header Parameters
- x-zitadel-orgid string
The default is always the organization of the requesting user. If you like to update a user from another organization include the header. Make sure the requesting user has permission in the requested organization.
- 200
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toprofile object
firstName stringlastName stringnickName stringdisplayName stringa user can set his display name, if nothing is set ZITADEL computes "first_name last_name"
preferredLanguage stringlanguage tag analog https://tools.ietf.org/html/rfc3066
gender stringPossible values: [
GENDER_UNSPECIFIED
,GENDER_FEMALE
,GENDER_MALE
,GENDER_DIVERSE
]Default value:
GENDER_UNSPECIFIED
the gender of the human
avatarUrl stringavatar URL of the user
{
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
},
"profile": {
"firstName": "Gigi",
"lastName": "Giraffe",
"nickName": "gigi-giraffe",
"displayName": "Gigi Giraffe",
"preferredLanguage": "en",
"gender": "GENDER_UNSPECIFIED",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
}
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toprofile object
firstName stringlastName stringnickName stringdisplayName stringa user can set his display name, if nothing is set ZITADEL computes "first_name last_name"
preferredLanguage stringlanguage tag analog https://tools.ietf.org/html/rfc3066
gender stringPossible values: [
GENDER_UNSPECIFIED
,GENDER_FEMALE
,GENDER_MALE
,GENDER_DIVERSE
]Default value:
GENDER_UNSPECIFIED
the gender of the human
avatarUrl stringavatar URL of the user
{
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
},
"profile": {
"firstName": "Gigi",
"lastName": "Giraffe",
"nickName": "gigi-giraffe",
"displayName": "Gigi Giraffe",
"preferredLanguage": "en",
"gender": "GENDER_UNSPECIFIED",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
}
}
- Schema
- Example (from schema)
Schema
details object
sequence uint64on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
creationDate date-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs toprofile object
firstName stringlastName stringnickName stringdisplayName stringa user can set his display name, if nothing is set ZITADEL computes "first_name last_name"
preferredLanguage stringlanguage tag analog https://tools.ietf.org/html/rfc3066
gender stringPossible values: [
GENDER_UNSPECIFIED
,GENDER_FEMALE
,GENDER_MALE
,GENDER_DIVERSE
]Default value:
GENDER_UNSPECIFIED
the gender of the human
avatarUrl stringavatar URL of the user
{
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
},
"profile": {
"firstName": "Gigi",
"lastName": "Giraffe",
"nickName": "gigi-giraffe",
"displayName": "Gigi Giraffe",
"preferredLanguage": "en",
"gender": "GENDER_UNSPECIFIED",
"avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
}
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
- code int32
- message string
details object[]
Array [@type string]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}