Class LoginTicket (8.3.0)

Package

google-auth-library

Constructors

(constructor)(env, pay)

constructor(env?: string, pay?: TokenPayload);

Create a simple class to extract user ID from an ID Token

Parameters
Name Description
env string

Envelope of the jwt
pay TokenPayload

Payload of the jwt

Methods

getAttributes()

getAttributes(): {
        envelope: string | undefined;
        payload: TokenPayload | undefined;
    };

Returns attributes from the login ticket. This can contain various information about the user session.

The envelope and payload

Returns
Type Description
{ envelope: string | undefined; payload: TokenPayload | undefined; }

getEnvelope()

getEnvelope(): string | undefined;
Returns
Type Description
string | undefined

getPayload()

getPayload(): TokenPayload | undefined;
Returns
Type Description
TokenPayload | undefined

getUserId()

getUserId(): string | null;

Create a simple class to extract user ID from an ID Token

The user ID

Returns
Type Description
string | null