AdditionalUserInfo interface

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

Signature:

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:

readonly isNewUser: boolean;

AdditionalUserInfo.profile

Map containing IDP-specific user data.

Signature:

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

AdditionalUserInfo.providerId

Identifier for the provider used to authenticate this user.

Signature:

readonly providerId: string | null;

AdditionalUserInfo.username

The username if the provider is GitHub or Twitter.

Signature:

readonly username?: string | null;