ZITADEL Docs
APIsCore ResourcesV2User

User by ID

Returns the full user or Service Account including the profile, email, etc..

GET
/v2/users/{user_id}

Path Parameters

user_id*string

Response Body

application/json

curl -X GET "https://loading/v2/users/string"
{
  "details": {
    "sequence": 0,
    "changeDate": "2023-01-15T01:30:15.01Z",
    "resourceOwner": "string",
    "creationDate": "2023-01-15T01:30:15.01Z"
  },
  "user": {
    "userId": "string",
    "details": {
      "sequence": 0,
      "changeDate": "2023-01-15T01:30:15.01Z",
      "resourceOwner": "string",
      "creationDate": "2023-01-15T01:30:15.01Z"
    },
    "state": "USER_STATE_UNSPECIFIED",
    "username": "string",
    "loginNames": [
      "string"
    ],
    "preferredLoginName": "string",
    "human": {
      "userId": "string",
      "state": "USER_STATE_UNSPECIFIED",
      "username": "string",
      "loginNames": [
        "string"
      ],
      "preferredLoginName": "string",
      "profile": {
        "givenName": "string",
        "familyName": "string",
        "nickName": "string",
        "displayName": "string",
        "preferredLanguage": "string",
        "gender": "GENDER_UNSPECIFIED",
        "avatarUrl": "string"
      },
      "email": {
        "email": "string",
        "isVerified": true
      },
      "phone": {
        "phone": "string",
        "isVerified": true
      },
      "passwordChangeRequired": true,
      "passwordChanged": "2023-01-15T01:30:15.01Z",
      "mfaInitSkipped": "2023-01-15T01:30:15.01Z"
    }
  }
}

Was this page helpful?

Update User (Human)

Update User (Human): Deprecated: Use [UpdateUser](/reference/api/user/zitadel.user.v2.UserService.UpdateUser) to update a user. Update all information from a user.

Verify a passkey for a user

Verify a passkey for a user: Verify the passkey registration with the public key credential..