nylas
    Preparing search index...

    Interface CreateCustomAuthenticationGrantRequest

    Interface representing a request to create a grant.

    interface CreateCustomAuthenticationGrantRequest {
        provider:
            | "zoom"
            | "google"
            | "imap"
            | "microsoft"
            | "icloud"
            | "virtual-calendar"
            | "ews";
        scope?: string[];
        settings: Record<string, unknown> & { credentialId?: string };
        state?: string;
    }
    Index

    Properties

    provider scope? settings state?

    Properties

    provider:
        | "zoom"
        | "google"
        | "imap"
        | "microsoft"
        | "icloud"
        | "virtual-calendar"
        | "ews"

    OAuth provider

    scope?: string[]

    Optional list of scopes to request. If not specified it will use the integration default scopes.

    settings: Record<string, unknown> & { credentialId?: string }

    Settings required by provider. Can include 'credentialId' to specify which credential to use for authentication. If not specified, the connector's default credential will be used.

    Type declaration

    • OptionalcredentialId?: string

      Optional credential ID to use for this authentication. Allows selecting a specific set of provider credentials when multiple are configured.

    state?: string

    Optional state value to return to developer's website after authentication flow is completed.

    Settings

    Member Visibility

    On This Page

    Properties