ZITADEL Docs
APIsCore ResourcesV2User

GetUserByID

User by ID

Returns the full user object (human or machine) including the profile, email, etc..

GET
/v2/users/{user_id}

Path Parameters

user_id*string

Response Body

application/json

application/json

curl -X GET "https://loading/v2/users/string"
{
  "details": {
    "sequence": 0,
    "changeDate": "1s",
    "resourceOwner": "string",
    "creationDate": "1s"
  },
  "user": {
    "userId": "string",
    "details": {
      "sequence": 0,
      "changeDate": "1s",
      "resourceOwner": "string",
      "creationDate": "1s"
    },
    "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": "1s",
      "mfaInitSkipped": "1s"
    }
  }
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?