auth.userinfo.md

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.

Signature:

exportinterfaceUserInfo

Properties

Property	Type	Description
displayName	string | null	The display name of the user.
email	string | null	The email of the user.
phoneNumber	string | null	The phone number normalized based on the E.164 standard (e.g. +16505550101) for the user.
photoURL	string | null	The profile photo URL of the user.
providerId	string	The provider used to authenticate the user.
uid	string	The user's unique ID, scoped to the project.

UserInfo.displayName

The display name of the user.

Signature:

readonly displayName: string|null;

UserInfo.email

The email of the user.

Signature:

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.

Signature:

readonly phoneNumber: string|null;

UserInfo.photoURL

The profile photo URL of the user.

Signature:

readonly photoURL: string|null;

UserInfo.providerId

The provider used to authenticate the user.

Signature:

readonly providerId: string;

UserInfo.uid

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

Signature:

readonly uid: string;