Home > @firebase/auth > IdTokenResult

IdTokenResult interface

Interface representing ID token result obtained from User.getIdTokenResult().

Signature:

export interface IdTokenResult 

Description

It contains the ID token JWT string and other helper properties for getting different data associated with the token as well as all the decoded payload claims.

Note that these claims are not to be trusted as they are parsed client side. Only server side verification can guarantee the integrity of the token claims.

Properties

Property	Type	Description
authTime	string	The authentication time formatted as a UTC string.
claims	ParsedToken	The entire payload claims of the ID token including the standard reserved claims as well as the custom claims.
expirationTime	string	The ID token expiration time formatted as a UTC string.
issuedAtTime	string	The ID token issuance time formatted as a UTC string.
signInProvider	string | null	The sign-in provider through which the ID token was obtained (anonymous, custom, phone, password, etc).
signInSecondFactor	string | null	The type of second factor associated with this session, provided the user was multi-factor authenticated (eg. phone, etc).
token	string	The Firebase Auth ID token JWT string.