A collection of authentication related API endpoints

These endpoints allow for various functionality related to authentication. Also contains the Grants API and collection of provider API endpoints.

Hierarchy

  • Resource
    • Auth

Constructors

  • Parameters

    • apiClient: default

      The configured Nylas API client

    Returns Auth

Properties

apiClient: default
grants: Grants

Access the Grants API

Methods

  • Type Parameters

    • T

    Parameters

    • __namedParameters: DestroyParams

    Returns Promise<T>

  • Revoke a token (and the grant attached to the token)

    Parameters

    • token: string

      The token to revoke

    Returns Promise<boolean>

    True if the token was revoked successfully

  • Build the URL for admin consent authentication for Microsoft

    Parameters

    Returns string

    The URL for admin consent authentication

  • Build the URL for authenticating users to your application with OAuth 2.0

    Parameters

    Returns string

    The URL for hosted authentication

  • Build the URL for authenticating users to your application with OAuth 2.0 and PKCE IMPORTANT: YOU WILL NEED TO STORE THE 'secret' returned to use it inside the CodeExchange flow

    Parameters

    Returns PKCEAuthURL

    The URL for hosted authentication

Generated using TypeDoc