Get My Phone

GET 
/users/me/phone

Returns the phone number of the authenticated user and if the state is verified or not.

Responses

200

A successful response.

application/json

Schema

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 (string)

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 the phone or if the phone is managed outside ZITADEL

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-21T14:48:11.093Z",
    "changeDate": "2024-11-21T14:48:11.093Z",
    "resourceOwner": "69629023906488334"
  },
  "phone": {
    "phone": "+41 71 000 00 00",
    "isPhoneVerified": true
  }
}

application/grpc

Schema

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 (string)

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 the phone or if the phone is managed outside ZITADEL

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-21T14:48:11.094Z",
    "changeDate": "2024-11-21T14:48:11.094Z",
    "resourceOwner": "69629023906488334"
  },
  "phone": {
    "phone": "+41 71 000 00 00",
    "isPhoneVerified": true
  }
}

application/grpc-web+proto

Schema

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 (string)

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 the phone or if the phone is managed outside ZITADEL

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2024-11-21T14:48:11.094Z",
    "changeDate": "2024-11-21T14:48:11.094Z",
    "resourceOwner": "69629023906488334"
  },
  "phone": {
    "phone": "+41 71 000 00 00",
    "isPhoneVerified": true
  }
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...