TokenPayload | Electron Forge

Hierarchy

TokenPayload

Index

Properties

Optional at_hash

at_hash?: string

Access token hash. Provides validation that the access token is tied to the identity token. If the ID token is issued with an access token in the server flow, this is always included. This can be used as an alternate mechanism to protect against cross-site request forgery attacks, but if you follow Step 1 and Step 3 it is not necessary to verify the access token.

aud

aud: string

Identifies the audience that this ID token is intended for. It must be one of the OAuth 2.0 client IDs of your application.

Optional azp

azp?: string

The client_id of the authorized presenter. This claim is only needed when the party requesting the ID token is not the same as the audience of the ID token. This may be the case at Google for hybrid apps where a web application and Android app have a different client_id but share the same project.

Optional email

email?: string

The user's email address. This may not be unique and is not suitable for use as a primary key. Provided only if your scope included the string "email".

Optional email_verified

email_verified?: boolean

True if the user's e-mail address has been verified; otherwise false.

exp

exp: number

The time the ID token expires, represented in Unix time (integer seconds).

Optional family_name

family_name?: string

The user's family name, in a displayable form. Might be provided when:

The request scope included the string "profile"
The ID token is returned from a token refresh
When name claims are present, you can use them to update your app's user records. Note that this claim is never guaranteed to be present.

Optional given_name

given_name?: string

The user's given name, in a displayable form. Might be provided when:

The request scope included the string "profile"
The ID token is returned from a token refresh
When name claims are present, you can use them to update your app's user records. Note that this claim is never guaranteed to be present.

Optional hd

hd?: string

The hosted G Suite domain of the user. Provided only if the user belongs to a hosted domain.

iat

iat: number

The time the ID token was issued, represented in Unix time (integer seconds).

iss

iss: string

The Issuer Identifier for the Issuer of the response. Always https://accounts.google.com or accounts.google.com for Google ID tokens.

Optional locale

locale?: string

The user's locale, represented by a BCP 47 language tag. Might be provided when a name claim is present.

Optional name

name?: string

The user's full name, in a displayable form. Might be provided when:

The request scope included the string "profile"
The ID token is returned from a token refresh
When name claims are present, you can use them to update your app's user records. Note that this claim is never guaranteed to be present.

Optional nonce

nonce?: string

The value of the nonce supplied by your app in the authentication request. You should enforce protection against replay attacks by ensuring it is presented only once.

Optional picture

picture?: string

The URL of the user's profile picture. Might be provided when:

The request scope included the string "profile"
The ID token is returned from a token refresh
When picture claims are present, you can use them to update your app's user records. Note that this claim is never guaranteed to be present.

Optional profile

profile?: string

The URL of the user's profile page. Might be provided when:

The request scope included the string "profile"
The ID token is returned from a token refresh
When profile claims are present, you can use them to update your app's user records. Note that this claim is never guaranteed to be present.

sub

sub: string

An identifier for the user, unique among all Google accounts and never reused. A Google account can have multiple emails at different points in time, but the sub value is never changed. Use sub within your application as the unique-identifier key for the user.