Get my user

Returns the full user object of the authenticated user including the profile, email, phone, etc

Responses

200
default

A successful response.

application/json
application/grpc
application/grpc-web+proto

Schema
Example (from schema)

Schema

user object
id string
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
state string
Possible values: [USER_STATE_UNSPECIFIED, USER_STATE_ACTIVE, USER_STATE_INACTIVE, USER_STATE_DELETED, USER_STATE_LOCKED, USER_STATE_SUSPEND, USER_STATE_INITIAL]
Default value: USER_STATE_UNSPECIFIED
current state of the user
userName string
loginNames string[]
preferredLoginName string
human object
one of type use human or machine
profile object
firstName string
lastName string
nickName string
displayName string
a user can set his display name, if nothing is set ZITADEL computes "first_name last_name"
preferredLanguage string
language tag analog https://tools.ietf.org/html/rfc3066
gender string
Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]
Default value: GENDER_UNSPECIFIED
the gender of the human
avatarUrl string
avatar URL of the user
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
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
machine object
one of type use human or machine
name string
description string
hasSecret boolean
accessTokenType string
Possible values: [ACCESS_TOKEN_TYPE_BEARER, ACCESS_TOKEN_TYPE_JWT]
Default value: ACCESS_TOKEN_TYPE_BEARER
Type of access token to receive
lastLogin date-time
The timestamp of the last successful login

{
  "user": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-11",
      "changeDate": "2023-05-11",
      "resourceOwner": "69629023906488334"
    },
    "state": "USER_STATE_UNSPECIFIED",
    "userName": "gigi-giraffe",
    "loginNames": [
      "gigi@zitadel.com",
      "gigi@zitadel.zitadel.ch"
    ],
    "preferredLoginName": "gigi@zitadel.com",
    "human": {
      "profile": {
        "firstName": "Gigi",
        "lastName": "Giraffe",
        "nickName": "gigi-giraffe",
        "displayName": "Gigi Giraffe",
        "preferredLanguage": "en",
        "gender": "GENDER_UNSPECIFIED",
        "avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
      },
      "email": {
        "email": "gigi@zitadel.com",
        "isEmailVerified": true
      },
      "phone": {
        "phone": "+41 71 000 00 00",
        "isPhoneVerified": true
      }
    },
    "machine": {
      "name": "zitadel",
      "description": "The one and only IAM",
      "hasSecret": "true",
      "accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
    }
  },
  "lastLogin": "2023-05-11"
}

Schema
Example (from schema)

Schema

user object
id string
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
state string
Possible values: [USER_STATE_UNSPECIFIED, USER_STATE_ACTIVE, USER_STATE_INACTIVE, USER_STATE_DELETED, USER_STATE_LOCKED, USER_STATE_SUSPEND, USER_STATE_INITIAL]
Default value: USER_STATE_UNSPECIFIED
current state of the user
userName string
loginNames string[]
preferredLoginName string
human object
one of type use human or machine
profile object
firstName string
lastName string
nickName string
displayName string
a user can set his display name, if nothing is set ZITADEL computes "first_name last_name"
preferredLanguage string
language tag analog https://tools.ietf.org/html/rfc3066
gender string
Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]
Default value: GENDER_UNSPECIFIED
the gender of the human
avatarUrl string
avatar URL of the user
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
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
machine object
one of type use human or machine
name string
description string
hasSecret boolean
accessTokenType string
Possible values: [ACCESS_TOKEN_TYPE_BEARER, ACCESS_TOKEN_TYPE_JWT]
Default value: ACCESS_TOKEN_TYPE_BEARER
Type of access token to receive
lastLogin date-time
The timestamp of the last successful login

{
  "user": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-11",
      "changeDate": "2023-05-11",
      "resourceOwner": "69629023906488334"
    },
    "state": "USER_STATE_UNSPECIFIED",
    "userName": "gigi-giraffe",
    "loginNames": [
      "gigi@zitadel.com",
      "gigi@zitadel.zitadel.ch"
    ],
    "preferredLoginName": "gigi@zitadel.com",
    "human": {
      "profile": {
        "firstName": "Gigi",
        "lastName": "Giraffe",
        "nickName": "gigi-giraffe",
        "displayName": "Gigi Giraffe",
        "preferredLanguage": "en",
        "gender": "GENDER_UNSPECIFIED",
        "avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
      },
      "email": {
        "email": "gigi@zitadel.com",
        "isEmailVerified": true
      },
      "phone": {
        "phone": "+41 71 000 00 00",
        "isPhoneVerified": true
      }
    },
    "machine": {
      "name": "zitadel",
      "description": "The one and only IAM",
      "hasSecret": "true",
      "accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
    }
  },
  "lastLogin": "2023-05-11"
}

Schema
Example (from schema)

Schema

user object
id string
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
state string
Possible values: [USER_STATE_UNSPECIFIED, USER_STATE_ACTIVE, USER_STATE_INACTIVE, USER_STATE_DELETED, USER_STATE_LOCKED, USER_STATE_SUSPEND, USER_STATE_INITIAL]
Default value: USER_STATE_UNSPECIFIED
current state of the user
userName string
loginNames string[]
preferredLoginName string
human object
one of type use human or machine
profile object
firstName string
lastName string
nickName string
displayName string
a user can set his display name, if nothing is set ZITADEL computes "first_name last_name"
preferredLanguage string
language tag analog https://tools.ietf.org/html/rfc3066
gender string
Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]
Default value: GENDER_UNSPECIFIED
the gender of the human
avatarUrl string
avatar URL of the user
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
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
machine object
one of type use human or machine
name string
description string
hasSecret boolean
accessTokenType string
Possible values: [ACCESS_TOKEN_TYPE_BEARER, ACCESS_TOKEN_TYPE_JWT]
Default value: ACCESS_TOKEN_TYPE_BEARER
Type of access token to receive
lastLogin date-time
The timestamp of the last successful login

{
  "user": {
    "id": "69629023906488334",
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-11",
      "changeDate": "2023-05-11",
      "resourceOwner": "69629023906488334"
    },
    "state": "USER_STATE_UNSPECIFIED",
    "userName": "gigi-giraffe",
    "loginNames": [
      "gigi@zitadel.com",
      "gigi@zitadel.zitadel.ch"
    ],
    "preferredLoginName": "gigi@zitadel.com",
    "human": {
      "profile": {
        "firstName": "Gigi",
        "lastName": "Giraffe",
        "nickName": "gigi-giraffe",
        "displayName": "Gigi Giraffe",
        "preferredLanguage": "en",
        "gender": "GENDER_UNSPECIFIED",
        "avatarUrl": "https://api.zitadel.ch/assets/v1/avatar-32432jkh4kj32"
      },
      "email": {
        "email": "gigi@zitadel.com",
        "isEmailVerified": true
      },
      "phone": {
        "phone": "+41 71 000 00 00",
        "isPhoneVerified": true
      }
    },
    "machine": {
      "name": "zitadel",
      "description": "The one and only IAM",
      "hasSecret": "true",
      "accessTokenType": "ACCESS_TOKEN_TYPE_BEARER"
    }
  },
  "lastLogin": "2023-05-11"
}

An unexpected error response.

application/json
application/grpc
application/grpc-web+proto

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

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

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

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

GET /users/me

Authorization

type: oauth2flow: authorizationCodescopes: openid

Request

Base URL

https://$ZITADEL_DOMAIN/auth/v1

Bearer Token

Accept

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Get my user​

Authorization

Request

Get my user