Interface Grant

Interface representing a Nylas Grant object.

Hierarchy

  • Grant

Properties

createdAt email? grantStatus? id ip? name? provider providerUserId? scope settings? state? updatedAt? userAgent?

Properties

createdAt

createdAt: number

Unix timestamp when the grant was created.

Optional email

email?: string

Email address associated with the grant.

Optional grantStatus

grantStatus?: string

Status of the grant, if it is still valid or if the user needs to re-authenticate.

id

id: string

Globally unique object identifier.

Optional ip

ip?: string

End user's client IP address.

Optional name

name?: string

Name associated with the grant.

provider

provider: string

OAuth provider that the user authenticated with.

Optional providerUserId

providerUserId?: string

Provider's ID for the user this grant is associated with.

scope

scope: string[]

Scopes specified for the grant.

Optional settings

settings?: Record<string, unknown>

Settings required by the provider that were sent as part of the OAuth request.

Optional state

state?: string

Initial state that was sent as part of the OAuth request.

Optional updatedAt

updatedAt?: number

Unix timestamp when the grant was updated.

Optional userAgent

userAgent?: string

End user's client user agent.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc