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
Header Parameters
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.
- 200
- default
OK
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
phone object
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
Is true if the user verified the phone or if the phone is managed outside ZITADEL
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T12:33:12.625Z",
"changeDate": "2024-06-13T12:33:12.625Z",
"resourceOwner": "69629023906488334"
},
"phone": {
"phone": "+41 71 000 00 00",
"isPhoneVerified": true
}
}
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
phone object
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
Is true if the user verified the phone or if the phone is managed outside ZITADEL
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T12:33:12.626Z",
"changeDate": "2024-06-13T12:33:12.626Z",
"resourceOwner": "69629023906488334"
},
"phone": {
"phone": "+41 71 000 00 00",
"isPhoneVerified": true
}
}
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
phone object
mobile phone number of the user. (use global pattern of spec https://tools.ietf.org/html/rfc3966)
Is true if the user verified the phone or if the phone is managed outside ZITADEL
{
"details": {
"sequence": "2",
"creationDate": "2024-06-13T12:33:12.626Z",
"changeDate": "2024-06-13T12:33:12.626Z",
"resourceOwner": "69629023906488334"
},
"phone": {
"phone": "+41 71 000 00 00",
"isPhoneVerified": true
}
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}