Docs

PublicUserData

Information about the user that's publicly available.

Properties

  • Name
    firstName
    Type
    string | null
    Description

    The user's first name.

  • Name
    lastName
    Type
    string | null
    Description

    The user's last name.

  • Name
    imageUrl
    Type
    string
    Description

    Holds the default avatar or user's uploaded profile image. Compatible with Clerk's Image Optimization.

  • Name
    hasImage
    Type
    boolean
    Description

    A getter boolean to check if the user has uploaded an image or one was copied from OAuth. Returns false if Clerk is displaying an avatar for the user.

  • Name
    identifier
    Type
    string
    Description

    The user's identifier.

  • Name
    userId?
    Type
    string | null
    Description

    The user's ID.

Feedback

What did you think of this content?
Edit this page on GitHub

Last updated on