Back to Firebase Js Sdk

UserInfo interface

docs-devsite/auth.userinfo.md

12.12.12.1 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

UserInfo interface

User profile information, visible only to the Firebase project's apps.

<b>Signature:</b>

typescript
export interface UserInfo 

Properties

PropertyTypeDescription
displayNamestring | nullThe display name of the user.
emailstring | nullThe email of the user.
phoneNumberstring | nullThe phone number normalized based on the E.164 standard (e.g. +16505550101) for the user.
photoURLstring | nullThe profile photo URL of the user.
providerIdstringThe provider used to authenticate the user.
uidstringThe user's unique ID, scoped to the project.

UserInfo.displayName

The display name of the user.

<b>Signature:</b>

typescript
readonly displayName: string | null;

UserInfo.email

The email of the user.

<b>Signature:</b>

typescript
readonly email: string | null;

UserInfo.phoneNumber

The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user.

This is null if the user has no phone credential linked to the account.

<b>Signature:</b>

typescript
readonly phoneNumber: string | null;

UserInfo.photoURL

The profile photo URL of the user.

<b>Signature:</b>

typescript
readonly photoURL: string | null;

UserInfo.providerId

The provider used to authenticate the user.

<b>Signature:</b>

typescript
readonly providerId: string;

UserInfo.uid

The user's unique ID, scoped to the project.

<b>Signature:</b>

typescript
readonly uid: string;