Class Auth

constructor

• new Auth(apiClient, clientId, clientSecret): Auth

• Parameters

  • apiClient: default

  • clientId: string

  • clientSecret: string

  Returns Auth

apiClient

clientId

clientSecret

grants

providers

exchangeCodeForToken

• exchangeCodeForToken(payload): Promise<NylasResponse<CodeExchangeResponse>>

• Exchange an authorization code for an access token

  Parameters

  • payload: CodeExchangeRequest

    The request parameters for the code exchange

  Returns Promise<NylasResponse<CodeExchangeResponse>>

  Information about the Nylas application

refreshAccessToken

• refreshAccessToken(payload): Promise<NylasResponse<CodeExchangeResponse>>

• Exchange a refresh token for an access token (and if rotation enabled refresh token as well)

  Parameters

  • payload: TokenExchangeRequest

    The request parameters for the token exchange

  Returns Promise<NylasResponse<CodeExchangeResponse>>

  Information about the Nylas application

revoke

• revoke(accessToken): Promise<boolean>

• Revoke a single access token

  Parameters

  • accessToken: string

    The access token to revoke

  Returns Promise<boolean>

  True if the access token was revoked

serverSideHostedAuth

• serverSideHostedAuth(payload): Promise<NylasResponse<ServerSideHostedAuthResponse>>

• Create a new authorization request and get a new unique login url. Used only for hosted authentication. This is the initial step requested from the server side to issue a new login url.

  Parameters

  • payload: ServerSideHostedAuthRequest

    params to initiate hosted auth request

  Returns Promise<NylasResponse<ServerSideHostedAuthResponse>>

  True if the request was successful

urlForAdminConsent

• urlForAdminConsent(config): string

• Build the URL for admin consent authentication for Microsoft

  Parameters

  • config: URLForAdminConsentConfig

    Configuration for the authentication process

  Returns string

  The URL for hosted authentication

urlForAuthentication

• urlForAuthentication(config): string

• Build the URL for authenticating users to your application via Hosted Authentication

  Parameters

  • config: URLForAuthenticationConfig

    Configuration for the authentication process

  Returns string

  The URL for hosted authentication

urlForAuthenticationPKCE

• urlForAuthenticationPKCE(config): PKCEAuthURL

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

  Parameters

  • config: URLForAuthenticationConfig

    Configuration for the authentication process

  Returns PKCEAuthURL

  The URL for hosted authentication

validateAccessToken

• validateAccessToken(token): Promise<NylasResponse<OpenID>>

• Validate and retrieve information about an access token

  Parameters

  • token: string

    The access token

  Returns Promise<NylasResponse<OpenID>>

  Information about the access token

validateIDToken

• validateIDToken(token): Promise<NylasResponse<OpenID>>

• Validate and retrieve information about an ID token

  Parameters

  • token: string

    The ID token

  Returns Promise<NylasResponse<OpenID>>

  Information about the ID token