Skip to main content

Get User Email (Human)​

Get the email address and the verification state of the address.

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
  • email object
  • email string

    email address of the user. (spec: https://tools.ietf.org/html/rfc2822#section-3.4.1)

  • isEmailVerified boolean

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

GET /users/:userId/email

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/management/v1
Bearer Token
userId — path required
x-zitadel-orgid — header
Accept
curl -L -X GET 'https://$ZITADEL_DOMAIN/management/v1/users/:userId/email' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'