Nylas Docs

The Nylas Developer Hub

Welcome to the Nylas developer hub. You'll find comprehensive guides and documentation to help you start working with Nylas as quickly as possible, as well as support if you get stuck. Let's jump right in!

Developer Guide


This guide covers everything you need to know to authenticate accounts through the Nylas API. We'll walk through several steps to get you set up. By the end you'll have the knowledge to authenticate user accounts to your application in production!

Looking to authenticate an account for development or testing?

If all you need is an account access token so you can test Nylas or start developing with Nylas, we make it easy to authenticate accounts through the Nylas Dashboard. Take a look at our guide to get your API keys for details.

Nylas integrates with 100% of email, calendar, and contacts providers and we support several authentication types including modern OAuth authentication for Google and Microsoft accounts and secure password authentication for legacy servers.

Furthermore, Nylas supports identity providers (IDP) with single sign on (SSO) capabilities like Okta and OneLogin. If your customers require SSO for their Office365 or GSuite accounts through a 3rd party IDP, as long as you support OAuth authentication for Office365 or GSuite you can authenticate these accounts as you normally would with no additional setup.

To get started supporting OAuth, please see our Office365 OAuth Setup Guide and Google OAuth Setup Guide.

Get your developer API keys

If you haven't already done so, please sign up or login to the Nylas Dashboard to access your application's client_id before moving forward. See the Get Your Developer API Keys guide if you need help.

The Basics of Authentication with Nylas

There are two main authentication flows that allow you to start syncing account data with Nylas: hosted and native.
Hosted Authentication - This is the quickest and easiest way to setup user authentication for your app. Simply redirect users to a Nylas login page and we'll handle the rest including auto-detection of third party providers and managing token exchanges.
Native Authentication - This is for developers who want to completely whitelabel the authentication experience to perfectly match your app. This is significantly more complicated than hosted authentication, so it's only recommended for developers who absolutely need the customization control.

Hosted Authentication

Hosted Authentication is the fastest way to authenticate users to your application through a login experience hosted by Nylas. All you need to do is redirect your user to Nylas' login page. We'll handle provider detection, authentication error handling, and autofill server connection settings.

→ Continue with Hosted Authentication

Native Authentication

With Native Authentication, you can authenticate users directly in-app without ever needing to redirect to Nylas. This gives you full control over the flow and look & feel of the login experience, and also allows you to control which kinds of providers your application supports. With Native Authentication, you'll need to set up developer apps with underlying providers like Google and Microsoft and configure your Nylas application to use them.

→ Continue with Native Authentication

Updated 7 days ago

What's Next

Get started with the authentication flow of your choice below.

Hosted Authentication
Native Authentication


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.