nylas
    Preparing search index...

    Interface Grant

    Interface representing a Nylas Grant object.

    interface Grant {
        createdAt: number;
        credentialId?: string;
        email?: string;
        grantStatus?: string;
        id: string;
        ip?: string;
        name?: string;
        provider: string;
        providerUserId?: string;
        scope: string[];
        settings?: Record<string, unknown>;
        state?: string;
        updatedAt?: number;
        userAgent?: string;
    }
    Index

    Properties

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

    Properties

    createdAt: number

    Unix timestamp when the grant was created.

    credentialId?: string

    The credential ID that was used to create this grant. This links the grant to a specific set of provider credentials.

    email?: string

    Email address associated with the grant.

    grantStatus?: string

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

    id: string

    Globally unique object identifier.

    ip?: string

    End user's client IP address.

    name?: string

    Name associated with the grant.

    provider: string

    OAuth provider that the user authenticated with.

    providerUserId?: string

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

    scope: string[]

    Scopes specified for the grant.

    settings?: Record<string, unknown>

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

    state?: string

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

    updatedAt?: number

    Unix timestamp when the grant was updated.

    userAgent?: string

    End user's client user agent.

    Settings

    Member Visibility

    On This Page

    Properties