Skip to main content

User by ID​

Returns the full user object (human or machine) including the profile, email, etc.

Path Parameters
    userId string required

    User ID of the user you like to get.

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

    changeDate date-time

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

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

    resourceOwner resource_owner is the organization or instance_id an object belongs to
    user object
    userId string
    state string

    Possible values: [USER_STATE_UNSPECIFIED, USER_STATE_ACTIVE, USER_STATE_INACTIVE, USER_STATE_DELETED, USER_STATE_LOCKED, 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

    userId string

    Unique identifier of the user.

    state string

    Possible values: [USER_STATE_UNSPECIFIED, USER_STATE_ACTIVE, USER_STATE_INACTIVE, USER_STATE_DELETED, USER_STATE_LOCKED, USER_STATE_INITIAL]

    Default value: USER_STATE_UNSPECIFIED

    current state of the user

    username string

    Username of the user, which can be globally unique or unique on organization level.

    loginNames string[]

    Possible usable login names for the user.

    preferredLoginName string

    Preferred login name of the user.

    profile object

    Profile information of the user.

    givenName string

    Possible values: non-empty and <= 200 characters

    familyName string

    Possible values: non-empty and <= 200 characters

    nickName string

    Possible values: <= 200 characters

    displayName string

    Possible values: <= 200 characters

    preferredLanguage string

    Possible values: <= 10 characters

    gender string

    Possible values: [GENDER_UNSPECIFIED, GENDER_FEMALE, GENDER_MALE, GENDER_DIVERSE]

    Default value: GENDER_UNSPECIFIED

    avatarUrl string

    avatar URL of the user

    email object

    Email of the user, if defined.

    email string

    Possible values: non-empty and <= 200 characters

    isVerified boolean
    phone object

    Phone of the user, if defined.

    phone string

    Possible values: <= 200 characters

    isVerified boolean
    passwordChangeRequired boolean

    User is required to change the used password on the next login.

    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

GET /v2beta/users/:userId

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN
Bearer Token
userId — path required
Accept
curl / cURL
curl -L -X GET 'https://$CUSTOM-DOMAIN/v2beta/users/:userId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'