openapi: 3.1.0
info:
title: Nylas API (v3) Admin Auth API
description: 'Nylas provides unified APIs for email, calendar, contacts, and
scheduling across many underlying providers (Google, Microsoft, IMAP,
etc.). Resources are scoped to a grant that represents an end-user
connection. Endpoint scaffold below is derived from the public v3
developer documentation at https://developer.nylas.com/docs/.
'
version: '3.0'
contact:
name: Nylas Developers
url: https://developer.nylas.com
servers:
- url: https://api.us.nylas.com
description: United States region
- url: https://api.eu.nylas.com
description: European Union region
security:
- BearerAuth: []
tags:
- name: Auth
paths:
/v3/connect/custom:
post:
tags:
- Auth
summary: Create a custom authentication grant
responses:
'200':
description: A grant has been created.
/v3/connect/auth:
get:
tags:
- Auth
summary: Begin hosted OAuth authentication
responses:
'302':
description: Redirects to the configured authentication provider.
/v3/connect/token:
post:
tags:
- Auth
summary: Exchange an authorization code for tokens
responses:
'200':
description: Returns access and refresh tokens.
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: 'Server-side requests use an API key issued in the Nylas dashboard
and presented as a Bearer token. User-level requests use an
access token obtained via the OAuth 2.0 flow.
'