React Native Auth0 - v5.5.0
    Preparing search index...

    Type Alias User

    Represents the standard profile information of an authenticated user, typically decoded from the ID token.

    Claims are mapped to camelCase for consistency within the JavaScript/TypeScript ecosystem.

    type User = {
        sub: string;
        name?: string;
        givenName?: string;
        familyName?: string;
        middleName?: string;
        nickname?: string;
        preferredUsername?: string;
        profile?: string;
        picture?: string;
        website?: string;
        email?: string;
        emailVerified?: boolean;
        gender?: string;
        birthdate?: string;
        zoneinfo?: string;
        locale?: string;
        phoneNumber?: string;
        phoneNumberVerified?: boolean;
        address?: string;
        updatedAt?: string;
        [key: string]: any;
    }

    Indexable

    • [key: string]: any

      Allows for additional, non-standard claims in the user profile.

    Index

    Properties

    sub name? givenName? familyName? middleName? nickname? preferredUsername? profile? picture? website? email? emailVerified? gender? birthdate? zoneinfo? locale? phoneNumber? phoneNumberVerified? address? updatedAt?

    Properties

    sub: string

    The user's unique identifier (subject claim).

    name?: string

    The user's full name.

    givenName?: string

    The user's given name or first name.

    familyName?: string

    The user's family name or last name.

    middleName?: string

    The user's middle name.

    nickname?: string

    The user's nickname.

    preferredUsername?: string

    The user's preferred username.

    profile?: string

    URL of the user's profile page.

    picture?: string

    URL of the user's profile picture.

    website?: string

    URL of the user's website.

    email?: string

    The user's primary email address.

    emailVerified?: boolean

    true if the user's email address has been verified, false otherwise.

    gender?: string

    The user's gender.

    birthdate?: string

    The user's birthdate, represented as a YYYY-MM-DD string.

    zoneinfo?: string

    The user's time zone, e.g., "America/Los_Angeles".

    locale?: string

    The user's locale, e.g., "en-US".

    phoneNumber?: string

    The user's phone number.

    phoneNumberVerified?: boolean

    true if the user's phone number has been verified, false otherwise.

    address?: string

    The user's postal address.

    updatedAt?: string

    The timestamp when the user's profile was last updated.

    Settings

    Member Visibility

    On This Page

    Properties