Custom Authentication
POST {{baseUrl}}/v3/connect/custom
Manually create a grant using a custom authentication flow.
If you are handling the OAuth flow in your own application or want to migrate existing users,
Custom Authentication allows you to provide the user refresh_token
in order to create a grant.
If a user previously authenticated with your Nylas application using the same email account, Nylas detects this and re-authenticates the existing grant instead of creating a new one. The API response contains the existing grant_id
for the user.
Request Body
{"provider"=>"<string>", "settings"=>"<object>", "state"=>"<string>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"request_id":"\u003cstring\u003e","data":{"id":"\u003cstring\u003e","provider":"\u003cstring\u003e","scope":["\u003cstring\u003e","\u003cstring\u003e"],"created_at":"\u003cinteger\u003e","grant_status":"\u003cstring\u003e","email":"\u003cstring\u003e","user_agent":"\u003cstring\u003e","ip":"\u003cstring\u003e","state":"\u003cstring\u003e","updated_at":"\u003cinteger\u003e"}}