Get User Profile (Human)
GET/users/:userId/profile
Get basic information like first_name and last_name of a user.
Deprecated: please use user service v2 GetUserByID
Request​
Path Parameters
Header Parameters
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.
Responses​
- 200
- default
OK
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
profile
object
a user can set the display name, if nothing is set ZITADEL computes "first_name last_name"
language tag analog https://tools.ietf.org/html/rfc3066
Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]
Default value: GENDER_UNSPECIFIED
the gender of the human
avatar URL of the user
{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-31T12:22:58.633Z",
    "changeDate": "2024-07-31T12:22:58.633Z",
    "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
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
profile
object
a user can set the display name, if nothing is set ZITADEL computes "first_name last_name"
language tag analog https://tools.ietf.org/html/rfc3066
Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]
Default value: GENDER_UNSPECIFIED
the gender of the human
avatar URL of the user
{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-31T12:22:58.634Z",
    "changeDate": "2024-07-31T12:22:58.634Z",
    "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
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
profile
object
a user can set the display name, if nothing is set ZITADEL computes "first_name last_name"
language tag analog https://tools.ietf.org/html/rfc3066
Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]
Default value: GENDER_UNSPECIFIED
the gender of the human
avatar URL of the user
{
  "details": {
    "sequence": "2",
    "creationDate": "2024-07-31T12:22:58.634Z",
    "changeDate": "2024-07-31T12:22:58.634Z",
    "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
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}
- Schema
- Example (from schema)
Schema
- Array [ 
- ] 
details
object[]
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}