Connected Accounts, quickstart doc updates #271
Conversation
priley86
changed the title
priley86
changed the base branch from
main
to
feat/connected_accounts_doc_updates
pmalouin
left a comment
pmalouin
left a comment
There was a problem hiding this comment.
awesome! couple of minor things and some ideas
|
|
||
| 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>: |
There was a problem hiding this comment.
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)
| <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 > APIs</strong>, locate the My Account API banner, and select <strong>Activate</strong> to activate the My Account API.</li> |
There was a problem hiding this comment.
it is called "Auth0 My Account API" in the dashboard. I think it might be preferable to use the exact name?
| <ul> | ||
| <li>Navigate to <strong>Applications > 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> |
There was a problem hiding this comment.
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)
| AUTH0_DOMAIN='<your-auth0-domain>' | ||
| AUTH0_CLIENT_ID='<your-auth0-application-client-id>' | ||
| AUTH0_CLIENT_SECRET='<your-auth0-application-client-secret>' | ||
| AUTH0_SCOPE='openid profile email offline_access' |
There was a problem hiding this comment.
Not needed for nextjs-auth0, because the default requested scopes include offline_access.
| AUTH0_SCOPE='openid profile email offline_access' |
|
|
||
| AUTH0_AUDIENCE="https://your.domain.us.langgraph.app" | ||
| AUTH0_SCOPE="openid profile email" | ||
| AUTH0_SCOPE="openid profile email offline_access" |
There was a problem hiding this comment.
Not needed for nextjs-auth0, because the default requested scopes include offline_access.
| AUTH0_SCOPE="openid profile email offline_access" |
| AUTH0_DOMAIN='<your-auth0-domain>' | ||
| AUTH0_CLIENT_ID='<your-auth0-application-client-id>' | ||
| AUTH0_CLIENT_SECRET='<your-auth0-application-client-secret>' | ||
| AUTH0_SCOPE='openid profile email offline_access' |
There was a problem hiding this comment.
Not needed for nextjs-auth0, because the default requested scopes include offline_access.
| AUTH0_SCOPE='openid profile email offline_access' |
| AUTH0_CUSTOM_API_CLIENT_ID=your-resource-server-client-id | ||
| AUTH0_CUSTOM_API_CLIENT_SECRET=your-resource-server-client-secret |
There was a problem hiding this comment.
| AUTH0_CUSTOM_API_CLIENT_ID=your-resource-server-client-id | |
| AUTH0_CUSTOM_API_CLIENT_SECRET=your-resource-server-client-secret | |
| AUTH0_CUSTOM_API_CLIENT_ID=your-custom-api-client-id | |
| AUTH0_CUSTOM_API_CLIENT_SECRET=your-custom-api-client-secret |
|
|
||
| **Client dependencies:** | ||
|
|
||
| - `@auth0/auth0-spa-js`: Auth0 SPA SDK for client-side authentication |
There was a problem hiding this comment.
This quickstart does not seem to describe the initialization snippet for @auth0/auth0-spa-js, which has some trickiness that comes from the new connected accounts flow:
https://github.com/auth0-samples/auth0-ai-samples/blob/3a91813012f5a1891e7e1044e6b8eca7d32edc34/call-apis-on-users-behalf/others-api/vercel-react-spa-js/client/src/lib/auth0.ts#L29-L34
Worth pursuing or do you think it's too detailed for this doc?
| <li> | ||
| Navigate to{" "} | ||
| <strong> | ||
| Applications > 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. |
There was a problem hiding this comment.
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 <strong>Add Application</strong> button in the right top corner.
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
References
https://auth0team.atlassian.net/browse/AIDX-240
Testing
Checklist