Interface CodeExchangeResponse

Interface of a Nylas code exchange response

Hierarchy

  • CodeExchangeResponse

Properties

accessToken email expiresIn grantId idToken? provider? refreshToken? scope tokenType?

Properties

accessToken

accessToken: string

Supports exchanging the code for tokens, or refreshing an access token using [Auth.refreshAccessToken][com.nylas.resources.Auth.refreshAccessToken].

email

email: string

Email address of the grant that is created.

expiresIn

expiresIn: number

The remaining lifetime of the access token in seconds.

grantId

grantId: string

Nylas grant ID that is now successfully created.

Optional idToken

idToken?: string

A JWT that contains identity information about the user that is digitally signed by Nylas.

Optional provider

provider?: Provider

The provider that the code was exchanged with.

Optional refreshToken

refreshToken?: string

Only returned if the code was requested using [AccessType.OFFLINE][com.nylas.models.AccessType.OFFLINE].

scope

scope: string

List of scopes associated with this token.

Optional tokenType

tokenType?: string

Currently always Bearer.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc