Connected Accounts, quickstart doc updates #271

priley86 · 2025-11-13T20:58:58Z

Description

Extends #156 with quickstart updates for the Connected Accounts features being added to Auth0 AI SDKs.

related quickstart pr's currently being prepared:
auth0/auth0-ai-js#291
auth0-samples/auth0-ai-samples#43
auth0-samples/auth0-assistant0#18
auth0/auth0-ai-js#291

References

https://auth0team.atlassian.net/browse/AIDX-240

Testing

Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors.

Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests.

Also include details of the environment this PR was developed in (language/platform/browser version).

This change adds test coverage for new/changed/fixed functionality

Checklist

I have added documentation for new/changed functionality in this PR or in auth0.com/docs
All active GitHub checks for tests, formatting, and security are passing
The correct base branch is being used, if not the default branch

pmalouin

awesome! couple of minor things and some ideas

pmalouin · 2025-11-14T02:04:15Z

auth4genai/snippets/get-started/prerequisites/call-others-api.jsx


  steps.push(
    <Step key="my-account-api" title="Configure My Account API">
      In the Auth0 Dashboard, configure the <a href="https://auth0.com/docs/manage-users/my-account-api" target="_blank">My Account API</a> to enable <a href="/intro/account-linking">account linking</a>:


Should we remove language about "account linking" here? We are actually describing the steps to Authorize access from your application to the My Account API (it's an application access policy configuration, not specifically related to account linking or even connected accounts)

we could simply omit this bit? I do consider this section a prerequisite but do not have strong preference at all.

e.g.:

In the Auth0 Dashboard, configure the <a href="https://auth0.com/docs/manage-users/my-account-api" target="_blank">My Account API</a>:

Not sure if you have something more specific in mind though!

asked the same question to @lrzhou25 here: https://github.com/auth0/docs-v2/pull/156/files#r2525585754

I'm in favor of removing, but would like her to weigh in to be sure.

yes let's remove it. when i originally made the update, i was still under the impression from this ticket that connected accounts would replace the account linking flow, but it seems like it does not?

pmalouin · 2025-11-14T02:05:08Z

auth4genai/snippets/get-started/prerequisites/call-others-api.jsx

    <Step key="my-account-api" title="Configure My Account API">
      In the Auth0 Dashboard, configure the <a href="https://auth0.com/docs/manage-users/my-account-api" target="_blank">My Account API</a> to enable <a href="/intro/account-linking">account linking</a>:
      <ul>
        <li>Navigate to <strong>Authentication &gt; APIs</strong>, locate the My Account API banner, and select <strong>Activate</strong> to activate the My Account API.</li>


it is called "Auth0 My Account API" in the dashboard. I think it might be preferable to use the exact name?

pmalouin · 2025-11-14T02:08:03Z

auth4genai/snippets/get-started/prerequisites/call-others-api.jsx

          <ul>
            <li>Navigate to <strong>Applications &gt; Applications</strong> and select your client application.</li>
            <li>Under <strong>APIs</strong>, toggle on <strong>Auth0 My Account API</strong>.</li>
            <li>Select the <a href="https://auth0.com/docs/manage-users/my-account-api#scope" target="_blank">Connected Accounts scopes</a> for the application in the dropdown.</li>


Perhaps we should indicate that the create:me:connected_accounts scope is the only required scope here (so the user knows to at least enable that one)

auth4genai/snippets/get-started/vercel-ai-next-js/call-others-api.mdx

auth4genai/snippets/get-started/langchain-next-js/call-others-api.mdx

auth4genai/snippets/get-started/vercel-ai-next-js/call-others-api.mdx

auth4genai/snippets/get-started/vercel-ai-react-spa-js/call-others-api.mdx

pmalouin · 2025-11-14T02:26:36Z

auth4genai/snippets/get-started/prerequisites/call-others-api.jsx

              <li>
                Navigate to{" "}
                <strong>
                  Applications &gt; APIs
                </strong>
              </li>
              <li>
                Click the{" "}
                <strong>Create API</strong> button to create a new Custom API.
              </li>
              <li>
                Go to the Custom API you created and click the <strong>Add Application</strong> button in the right top corner.


in this section, we should not tell the reader to create another API, rather to use the one that was just created already above. I think we should remove everything above here and reword this to:

<li> From the Settings page of the Custom API that you just created, click the Add Application button in the right top corner.

thank you! this was the reference i was looking for.. will update 👍

updated after reviewing that flow here in my Dashboard:
76c7851

Co-authored-by: Patrick Malouin <patrick.malouin@okta.com>

auth4genai/snippets/get-started/prerequisites/call-others-api.jsx

pmalouin

just one last editorial suggestion, but waiting on Lucy's feedback. Approving from my side in the mean time ✅

lrzhou25 · 2025-11-14T22:35:14Z

auth4genai/snippets/get-started/langchain-next-js/call-others-api.mdx

+To get your Auth0 application's `AUTH0_DOMAIN`, `AUTH0_CLIENT_ID`, and `AUTH0_CLIENT_SECRET`, navigate to <strong>Applications > Applications </strong> in the Auth0 Dashboard and select your Regular Web application. You'll find these values in the **Basic Information** section at the top.
+Copy each value to the matching setting.
+
+To get your API's `AUTH0_AUDIENCE`, navigate to <strong>APIs > APIs </strong> in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.


Suggested change

To get your API's `AUTH0_AUDIENCE`, navigate to APIs > APIs in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.

To get your API's `AUTH0_AUDIENCE`, navigate to Applications > APIs in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.

lrzhou25 · 2025-11-14T22:36:01Z

auth4genai/snippets/get-started/langchain-next-js/call-others-api.mdx

+Copy each value to the matching setting.

-To get your Auth0 application's `AUTH0_DOMAIN`, `AUTH0_CLIENT_ID`, and `AUTH0_CLIENT_SECRET`, navigate to the **Settings** tab in the Auth0 Dashboard. You'll find these values in the **Basic Information** section at the top.
+To get your API's `AUTH0_AUDIENCE`, navigate to <strong>APIs > APIs </strong> in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.


Suggested change

To get your API's `AUTH0_AUDIENCE`, navigate to APIs > APIs in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.

To get your API's `AUTH0_AUDIENCE`, navigate to Applications > APIs in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.

lrzhou25 · 2025-11-14T22:44:55Z

auth4genai/snippets/get-started/prerequisites/call-others-api.jsx


  steps.push(
    <Step key="my-account-api" title="Configure My Account API">
      In the Auth0 Dashboard, configure the <a href="https://auth0.com/docs/manage-users/my-account-api" target="_blank">My Account API</a> to enable <a href="/intro/account-linking">account linking</a>:


yes let's remove it. when i originally made the update, i was still under the impression from this ticket that connected accounts would replace the account linking flow, but it seems like it does not?

lrzhou25 · 2025-11-14T22:46:07Z

auth4genai/snippets/get-started/prerequisites/call-others-api.jsx

            <li>Navigate to <strong>Applications &gt; Applications</strong> and select your client application.</li>
            <li>Under <strong>APIs</strong>, toggle on <strong>Auth0 My Account API</strong>.</li>
-            <li>Select the <a href="https://auth0.com/docs/manage-users/my-account-api#scope" target="_blank">Connected Accounts scopes</a> for the application in the dropdown.</li>
+            <li>Select the <a href="https://auth0.com/docs/manage-users/my-account-api#scope" target="_blank">Connected Accounts scopes</a> for the application in the dropdown, ensuring that the <code>create:me:connected_accounts</code> permission at least is selected.</li>


Suggested change

<li>Select the <a href="https://auth0.com/docs/manage-users/my-account-api#scope" target="_blank">Connected Accounts scopes</a> for the application in the dropdown, ensuring that the <code>create:me:connected_accounts</code> permission at least is selected.</li>

<li>Select the <a href="https://auth0.com/docs/manage-users/my-account-api#scope" target="_blank">Connected Accounts scopes</a> for the application in the dropdown, ensuring that at least the <code>create:me:connected_accounts</code> permission is selected.</li>

lrzhou25 · 2025-11-14T22:49:37Z

auth4genai/snippets/get-started/prerequisites/call-others-api.jsx

+      <ul>
+        <li>Navigate to <strong>Applications &gt; Applications</strong> and select your client application.</li>
+        <li>On the <strong>Settings</strong> tab, scroll down to the <strong>Multi-Resource Refresh Token</strong> section.</li>
+        <li>Select <strong>Edit Configuration</strong> and then enable the MRRT toggle for the <strong>Auth0 My Account API</strong>.</li>


i think you also need to enable Allow Skipping User Consent for the My Account API in order for MRRT to work. i remember running into this error and someone else reporting this recently

i put that step under the My Account API config to reduce UX friction (the user having to go back and forth between My Account API config and then the application config for MRRT: https://docs.google.com/document/d/1OQ5nnWGvBtLAnk6QIsxicuCd2WA1OUbxsMSvyrk-gA8/edit?tab=t.0#heading=h.cisneua0vv4x

lrzhou25 · 2025-11-14T22:51:46Z

auth4genai/snippets/get-started/vercel-ai-react-spa-js/call-others-api.mdx

+To get your SPA application's `VITE_AUTH0_DOMAIN`, and `VITE_AUTH0_CLIENT_ID`, navigate to <strong>Applications > Applications </strong> in the Auth0 Dashboard and select your SPA application. You'll find these values in the **Basic Information** section at the top.
+Copy each value to the matching setting.
+
+To get your API's `AUTH0_AUDIENCE`, navigate to <strong>APIs > APIs </strong> in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.


Suggested change

To get your API's `AUTH0_AUDIENCE`, navigate to APIs > APIs in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.

To get your API's `AUTH0_AUDIENCE`, navigate to Applications > APIs in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.

lrzhou25 · 2025-11-14T22:52:17Z

auth4genai/snippets/get-started/vercel-ai-react-spa-js/call-others-api.mdx

+To get your SPA application's `VITE_AUTH0_DOMAIN`, and `VITE_AUTH0_CLIENT_ID`, navigate to <strong>Applications > Applications </strong> in the Auth0 Dashboard and select your SPA application. You'll find these values in the **Basic Information** section at the top.
+Copy each value to the matching setting.
+
+To get your API's `AUTH0_AUDIENCE`, navigate to <strong>APIs > APIs </strong> in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.


Suggested change

To get your API's `AUTH0_AUDIENCE`, navigate to APIs > APIs in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.

To get your API's `AUTH0_AUDIENCE`, navigate to Applications > APIs in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.

lrzhou25 · 2025-11-14T22:55:35Z

auth4genai/snippets/get-started/vercel-ai-react-spa-js/call-others-api.mdx


-  // Use Auth0 SPA SDK to request additional connection/scopes
-  const startFederatedLogin = useCallback(async () => {
+  // Use Auth0 SPA SDK to connect a third-party account


Suggested change

// Use Auth0 SPA SDK to connect a third-party account

// Use Auth0 SPA SDK to connect an external account

lrzhou25 · 2025-11-14T22:55:46Z

auth4genai/snippets/get-started/vercel-ai-react-spa-js/call-others-api.mdx

-          connection_scope: validScopes.join(" "), // Google-specific scopes
-          access_type: "offline",
-        },
+      // Use the connect account flow to request authorization+consent for the 3rd party API.


Suggested change

// Use the connect account flow to request authorization+consent for the 3rd party API.

// Use the connect account flow to request authorization+consent for the externalAPI.

lrzhou25 · 2025-11-14T22:58:57Z

auth4genai/snippets/get-started/langchain-next-js/call-others-api.mdx

+OPENAI_API_KEY="YOUR_API_KEY"
+```

 ### Set up Token Vault for Google social connection


i wonder if we should add a note here about how the user needs to select offline_access in the Auth0 Dashboard specifically for a Google social connection

lrzhou25 · 2025-11-14T23:43:41Z

auth4genai/snippets/get-started/vercel-ai-next-js/call-others-api.mdx

 export const withGoogleConnection = auth0AI.withTokenVault({
  connection: "google-oauth2",
-  scopes: ["https://www.googleapis.com/auth/calendar.events"],
+  scopes: ["openid", "https://www.googleapis.com/auth/calendar.events"],


slack comment here: https://auth0.slack.com/archives/C093BMP09HN/p1763163052908979?thread_ts=1762795719.829029&cid=C093BMP09HN

feat: [AIDX-240] Connected Account Flow, quickstart updates

f951961

priley86 changed the title ~~Connected Accounts quickstart doc updates~~ Connected Accounts, quickstart doc updates Nov 13, 2025

mintlify bot deployed to staging - auth4genai November 13, 2025 21:00 View deployment

priley86 changed the base branch from main to feat/connected_accounts_doc_updates November 13, 2025 21:00

priley86 marked this pull request as ready for review November 13, 2025 21:33

priley86 requested review from KarimTantawy5, lrzhou25 and pmalouin November 13, 2025 21:37

pmalouin reviewed Nov 14, 2025

View reviewed changes

Apply suggestions from code review

a404d33

Co-authored-by: Patrick Malouin <patrick.malouin@okta.com>

mintlify bot deployed to staging - auth4genai November 14, 2025 17:04 View deployment

fix: My Account API prerequisite updates

296dda0

mintlify bot deployed to staging - auth4genai November 14, 2025 18:23 View deployment

pmalouin reviewed Nov 14, 2025

View reviewed changes

auth4genai/snippets/get-started/prerequisites/call-others-api.jsx Show resolved Hide resolved

feat: code review updates

76c7851

mintlify bot deployed to staging - auth4genai November 14, 2025 19:39 View deployment

fix: jsx prop comments

695edc1

mintlify bot deployed to staging - auth4genai November 14, 2025 19:45 View deployment

pmalouin approved these changes Nov 14, 2025

View reviewed changes

lrzhou25 reviewed Nov 14, 2025

View reviewed changes

	To get your API's `AUTH0_AUDIENCE`, navigate to <strong>APIs > APIs </strong> in the Auth0 Dashboard and select your API. You'll find the identifier in the General Settings section at the top.
	To get your API's `AUTH0_AUDIENCE`, navigate to <strong>Applications > APIs </strong> in the Auth0 Dashboard and select your API. You'll find the identifier in the General Settings section at the top.

	<li>Select the <a href="https://auth0.com/docs/manage-users/my-account-api#scope" target="_blank">Connected Accounts scopes</a> for the application in the dropdown, ensuring that the <code>create:me:connected_accounts</code> permission at least is selected.</li>
	<li>Select the <a href="https://auth0.com/docs/manage-users/my-account-api#scope" target="_blank">Connected Accounts scopes</a> for the application in the dropdown, ensuring that at least the <code>create:me:connected_accounts</code> permission is selected.</li>

	// Use Auth0 SPA SDK to connect a third-party account
	// Use Auth0 SPA SDK to connect an external account

	// Use the connect account flow to request authorization+consent for the 3rd party API.
	// Use the connect account flow to request authorization+consent for the externalAPI.

Connected Accounts, quickstart doc updates #271

Are you sure you want to change the base?

Connected Accounts, quickstart doc updates #271

Uh oh!

Conversation

priley86 commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

References

Testing

Checklist

Uh oh!

pmalouin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pmalouin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

priley86 commented Nov 13, 2025 •

edited

Loading