nylas
    Preparing search index...

    Interface URLForAuthenticationConfig

    Configuration for generating a URL for OAuth 2.0 authentication.

    interface URLForAuthenticationConfig {
        accessType?: AccessType;
        clientId: string;
        credentialId?: string;
        includeGrantScopes?: boolean;
        loginHint?: string;
        prompt?: string;
        provider?: Provider;
        redirectUri: string;
        scope?: string[];
        smtpRequired?: boolean;
        state?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accessType? clientId credentialId? includeGrantScopes? loginHint? prompt? provider? redirectUri scope? smtpRequired? state?

    Properties

    accessType?: AccessType

    If the exchange token should return a refresh token too. Not suitable for client side or JavaScript apps.

    clientId: string

    The client ID of your application.

    credentialId?: string

    Optional credential ID to use for hosted authentication. Allows selecting a specific set of provider credentials when multiple are configured under a connector. If not specified, the connector's default credential will be used. This is supported for standard OAuth flows (response_type=code).

    includeGrantScopes?: boolean

    If set to true, the scopes granted to the application will be included in the response.

    loginHint?: string

    Prefill the login name (usually email) during authorization flow. If a Grant for the provided email already exists, a Grant's re-auth will automatically be initiated.

    prompt?: string

    The prompt parameter is used to force the consent screen to be displayed even if the user has already given consent to your application.

    provider?: Provider

    The integration provider type that you already had set up with Nylas for this application. If not set, the user is directed to the Hosted Login screen and prompted to select a provider.

    redirectUri: string

    Redirect URI of the integration.

    scope?: string[]

    A space-delimited list of scopes that identify the resources that your application could access on the user's behalf. If no scope is given, all of the default integration's scopes are used.

    smtpRequired?: boolean

    If set to true, the options=smtp_required parameter is added to the authentication URL. This forces users to provide SMTP settings during IMAP authentication, preventing send failures from missing SMTP configuration.

    state?: string

    Optional state to be returned after authentication

    Settings

    Member Visibility

    On This Page

    Properties