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 %}

AdditionalUserInfo interface

A structure containing additional user information from a federated identity provider.

Signature:

typescript

export interface AdditionalUserInfo

Properties

Property	Type	Description
isNewUser	boolean	Whether the user is new (created via sign-up) or existing (authenticated using sign-in).
profile	Record<string, unknown> \| null	Map containing IDP-specific user data.
providerId	string \| null	Identifier for the provider used to authenticate this user.
username	string \| null	The username if the provider is GitHub or Twitter.

AdditionalUserInfo.isNewUser

Whether the user is new (created via sign-up) or existing (authenticated using sign-in).

Signature:

typescript

readonly isNewUser: boolean;

AdditionalUserInfo.profile

Map containing IDP-specific user data.

Signature:

typescript

readonly profile: Record<string, unknown> | null;

AdditionalUserInfo.providerId

Identifier for the provider used to authenticate this user.

Signature:

typescript

readonly providerId: string | null;

AdditionalUserInfo.username

The username if the provider is GitHub or Twitter.

Signature:

typescript

readonly username?: string | null;