Guide to letting your users authorize an external API from your application.
Authorization overview.
ℹ️ Details on end user and organization information
end_user
and organization
information fields help identify which connection belongs to which end user and organization. This information is also used for display purposes in the Nango UI and, in some cases, for custom billing plans.end_user.id
is required. Pass in your internal ID of the user who initiated the authorization flow. This ID, and potentially the organization.id
, are necessary for reconciling the connection details that your backend receives from Nango after the connection is created (as described in the section 3).A
with user ID X
and email a@a.com
, then connection B
with the same user ID X
and email b@b.com
, both connections will reflect the latest data: b@b.com
. The same applies to org data—editing it updates all connections tied to that org ID.allowed_integrations
will display a list of integrations that the end user can pick from:Nango's default authorization UI.
allowed_integrations
will send the end user directly to this integration’s authorization flow:Nango's default authorization UI.
Nango's default authorization UI.
👩🏻💻 Simplified flow for development
nango.openConnectUI()
method in the frontend SDK, the connection ID is available in the event
parameter of the callback:POST
requests with the following JSON body:
connectionId
value alongside its corresponding user or organization, designated by endUser.endUserId
and endUser.organizationId
.