Class LoginTicket (8.3.0)

Package

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

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(): string | undefined;

Returns

Type	Description
string \| undefined

getPayload(): TokenPayload | undefined;

Returns

Type	Description
TokenPayload \| undefined

getUserId(): string | null;

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

The user ID

Returns

Type	Description
string \| null