Skip to main content

Get User Phone (Human)

Get the phone number and the verification state of the number. The phone number is only for informational purposes and to send messages, not for Authentication (2FA).

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 get a user from another organization include the header. Make sure the requesting user has permission in the requested organization.

Responses

OK


Schema
  • details object
  • sequence uint64

    on 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-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

  • changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

  • resourceOwner resource_owner is the organization an object belongs to
  • phone object
  • phone string

    mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)

  • isPhoneVerified boolean

    Is true if the user verified his phone or if the phone is managed outside ZITADEL

Loading...