Interface AdditionalUserInfo

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

const userCredential = await firebase.auth().signInAnonymously();
console.log('Additional user info: ', userCredential.additionalUserInfo);

auth/operation-not-allowed Thrown if anonymous accounts are not enabled. Enable anonymous accounts in the Firebase Console, under the Auth tab.

interface AdditionalUserInfo {
    isNewUser: boolean;
    profile?: Record<string, any>;
    providerId: string;
    username?: string;
}

Properties

isNewUser: boolean

Returns whether the user is new or existing.

profile?: Record<string, any>

Returns an Object containing IDP-specific user data if the provider is one of Facebook, GitHub, Google, Twitter, Microsoft, or Yahoo.

providerId: string

Returns the provider ID for specifying which provider the information in profile is for.

username?: string

Returns the username if the provider is GitHub or Twitter.