Skip to content

Commit 1ca6091

Browse files
lrzhou25lrzhou25
authored
A4AA QS Feedback (#413)
* Added API identifier language * Added dashboard links * Updated dashboard links in qs * Added language about custom API * Added dashboard links to main content * Removed Auth0 APIs link * Update call-others-api.jsx
1 parent 1fc9f4e commit 1ca6091

File tree

6 files changed

+26
-33
lines changed

6 files changed

+26
-33
lines changed

‎auth4genai/snippets/get-started/langchain-fastapi-py/call-others-api.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ OPENAI_API_KEY="YOUR_API_KEY"
5757
LANGGRAPH_API_URL=http://localhost:54367
5858
```
5959

60-
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 client application. You'll find these values in the **Basic Information** section at the top.
60+
To get your Auth0 application's `AUTH0_DOMAIN`, `AUTH0_CLIENT_ID`, and `AUTH0_CLIENT_SECRET`, navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/applications)</strong> in the Auth0 Dashboard and select your client application. You'll find these values in the **Basic Information** section at the top.
6161
Copy each value to the matching setting.
6262

6363
Next, run this command to generate a random 32 byte value and copy it to the `AUTH0_SECRET` field:
@@ -157,7 +157,7 @@ OPENAI_API_KEY="YOUR_API_KEY"
157157
LANGGRAPH_API_URL=http://localhost:54367
158158
```
159159

160-
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 client application. You'll find these values in the **Basic Information** section at the top.
160+
To get your Auth0 application's `AUTH0_DOMAIN`, `AUTH0_CLIENT_ID`, and `AUTH0_CLIENT_SECRET`, navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/applications)</strong> in the Auth0 Dashboard and select your client application. You'll find these values in the **Basic Information** section at the top.
161161
Copy each value to the matching setting.
162162

163163
Next, run this command to generate a random 32 byte value and copy it to the `AUTH0_SECRET` field.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,12 @@ OPENAI_API_KEY="YOUR_API_KEY"
4646
LANGGRAPH_API_URL=http://localhost:54367
4747
LANGCHAIN_CALLBACKS_BACKGROUND=false
4848
```
49-
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.
49+
To get your Auth0 application's `AUTH0_DOMAIN`, `AUTH0_CLIENT_ID`, and `AUTH0_CLIENT_SECRET`, navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/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.
5050
Copy each value to the matching setting.
5151

52-
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.
52+
To get your API's `AUTH0_AUDIENCE`, navigate to <strong>[Applications > APIs](https://manage.auth0.com/#/apis)</strong> in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.
5353

54-
To get your Custom API Client's `AUTH0_CUSTOM_API_CLIENT_ID`, and `AUTH0_CUSTOM_API_CLIENT_SECRET` navigate to <strong>Applications > Applications </strong> in the Auth0 Dashboard and select your Custom API Client application. You'll find these values in the **Basic Information** section at the top.
54+
To get your Custom API Client's `AUTH0_CUSTOM_API_CLIENT_ID`, and `AUTH0_CUSTOM_API_CLIENT_SECRET` navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/applications)</strong> in the Auth0 Dashboard and select your Custom API Client application. You'll find these values in the **Basic Information** section at the top.
5555
Copy each value to the matching setting.
5656

5757
Next, run this command to generate a random 32 byte value and copy it to the `AUTH0_SECRET` field:
@@ -127,12 +127,12 @@ OPENAI_API_KEY="YOUR_API_KEY"
127127
LANGGRAPH_API_URL=http://localhost:54367
128128
LANGCHAIN_CALLBACKS_BACKGROUND=false
129129
```
130-
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.
130+
To get your Auth0 application's `AUTH0_DOMAIN`, `AUTH0_CLIENT_ID`, and `AUTH0_CLIENT_SECRET`, navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/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.
131131
Copy each value to the matching setting.
132132

133-
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.
133+
To get your API's `AUTH0_AUDIENCE`, navigate to <strong>[Applications > APIs](https://manage.auth0.com/#/apis)</strong> in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.
134134

135-
To get your Custom API Client's `AUTH0_CUSTOM_API_CLIENT_ID`, and `AUTH0_CUSTOM_API_CLIENT_SECRET` navigate to <strong>Applications > Applications </strong> in the Auth0 Dashboard and select your Custom API Client application. You'll find these values in the **Basic Information** section at the top.
135+
To get your Custom API Client's `AUTH0_CUSTOM_API_CLIENT_ID`, and `AUTH0_CUSTOM_API_CLIENT_SECRET` navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/applications)</strong> in the Auth0 Dashboard and select your Custom API Client application. You'll find these values in the **Basic Information** section at the top.
136136
Copy each value to the matching setting.
137137

138138
Next, run this command to generate a random 32 byte value and copy it to the `AUTH0_SECRET` field:

‎auth4genai/snippets/get-started/prerequisites/account-app-steps.jsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export const AccountAndAppSteps = ({
3030
to create a new Auth0 Application.
3131
<ul>
3232
<li>
33-
Navigate to <strong>Applications {">"} Applications</strong> in the
33+
Navigate to <a href="https://manage.auth0.com/#/applications" target="_blank"><strong>Applications {">"} Applications</strong></a> in the
3434
left sidebar.
3535
</li>
3636
<li>

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

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -51,28 +51,21 @@ export const Prerequisites = ({
5151

5252
if (createAuth0ApiStep) {
5353
steps.push(
54-
<Step key="auth0-api" title="Create an Auth0 API">
54+
<Step key="auth0-api" title="Create a Custom API">
55+
A Custom API is an API you own that you want to secure using Auth0.
5556
<ul>
5657
<li>
5758
In your Auth0 Dashboard, go to{" "}
58-
<strong>Applications &gt; APIs</strong>.
59+
<a href="https://manage.auth0.com/#/apis" target="_blank"><strong>Applications &gt; APIs</strong></a>.
5960
</li>
60-
<li>Create a new API with an identifier (audience).</li>
61+
<li>Create a new API with an identifier (audience), for example, <code>https://my-custom-api.com</code>.</li>
6162
<li>
6263
Once API is created, go to the APIs{" "}
6364
<strong>Settings &gt; Access Settings</strong> and enable{" "}
6465
<strong>Allow Offline Access</strong>.
6566
</li>
66-
<li>Note down the API identifier for your environment variables.</li>
67+
<li>Note down the API identifier for your environment variables. You will use the API identifier as the audience parameter in token requests (<code>AUTH0_AUDIENCE</code>).</li>
6768
</ul>
68-
To learn more about Auth0 APIs, read{" "}
69-
<a
70-
href="https://auth0.com/docs/get-started/auth0-overview/set-up-apis"
71-
target="_blank"
72-
>
73-
APIs
74-
</a>
75-
.
7669
</Step>
7770
);
7871
}
@@ -94,7 +87,7 @@ export const Prerequisites = ({
9487
<br />
9588
<ul>
9689
<li>
97-
From the Settings page of the API that you just created, click the <strong>Add Application</strong> button in the right top corner. This will open a modal to create a new Custom API Client.
90+
From the <strong>Settings</strong> page of the API that you just created, click the <strong>Add Application</strong> button in the right top corner. This will open a modal to create a new Custom API Client.
9891
</li>
9992
<li>
10093
Give your Custom API Client a name in the Application Name field and click the <strong>Add</strong> button to create a new Custom API Client.
@@ -113,7 +106,7 @@ export const Prerequisites = ({
113106
The Connected Accounts flow uses the <a href="https://auth0.com/docs/manage-users/my-account-api" target="_blank">My Account API</a> to create and manage connected accounts for a user across supported external providers.<br/><br/>
114107
In the Auth0 Dashboard, configure the My Account API:
115108
<ul>
116-
<li>Navigate to <strong>Authentication &gt; APIs</strong>, locate the My Account API banner, and select <strong>Activate</strong> to activate the Auth0 My Account API.</li>
109+
<li>Navigate to <a href="https://manage.auth0.com/#/apis" target="_blank"><strong>Applications &gt; APIs</strong></a>, locate the My Account API banner, and select <strong>Activate</strong> to activate the Auth0 My Account API.</li>
117110
<li>Once activated, select <strong>Auth0 My Account API</strong> and then select the <strong>Applications</strong> tab.
118111
<ul>
119112
<li>Toggle your client application to authorize it to access the My Account API.</li>
@@ -130,15 +123,15 @@ export const Prerequisites = ({
130123
After your web application has been granted access to the My Account API, you will also need to leverage the <a href="https://auth0.com/docs/secure/tokens/refresh-tokens/multi-resource-refresh-token" target="_blank">Multi-Resource Refresh Token</a> feature, which enables the refresh token delivered to your application to also obtain an access token to call the My Account API. <br/><br/>
131124
You can quickly define a <a href="https://auth0.com/docs/secure/tokens/refresh-tokens/multi-resource-refresh-token/configure-and-implement-multi-resource-refresh-token" target="_blank">refresh token policy</a> for your application to use when requesting access tokens for the My Account API by doing the following:
132125
<ul>
133-
<li>Navigate to <strong>Applications &gt; Applications</strong> and select your client application.</li>
126+
<li>Navigate to <a href="https://manage.auth0.com/#/applications" target="_blank"><strong>Applications &gt; Applications</strong></a> and select your client application.</li>
134127
<li>On the <strong>Settings</strong> tab, scroll down to the <strong>Multi-Resource Refresh Token</strong> section.</li>
135128
<li>Select <strong>Edit Configuration</strong> and then enable the MRRT toggle for the <strong>Auth0 My Account API</strong>.</li>
136129
</ul>
137130
</Step>)
138131

139132
steps.push(
140133
<Step key="google-connection" title="Configure Google Social Integration">
141-
Set up a Google developer account that allows for third-party API calls by
134+
Set up a Google developer account that allows for external API calls by
142135
following the <a href="/integrations/google">Google Social Integration</a>{" "}
143136
instructions.
144137
</Step>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ AUTH0_CLIENT_SECRET='<your-auth0-application-client-secret>'
3636
OPENAI_API_KEY="YOUR_API_KEY"
3737
```
3838

39-
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 client application. You'll find these values in the **Basic Information** section at the top.
39+
To get your Auth0 application's `AUTH0_DOMAIN`, `AUTH0_CLIENT_ID`, and `AUTH0_CLIENT_SECRET`, navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/applications) </strong> in the Auth0 Dashboard and select your client application. You'll find these values in the **Basic Information** section at the top.
4040
Copy each value to the matching setting.
4141

4242
Next, run this command to generate a random 32 byte value and copy it to the `AUTH0_SECRET` field:
@@ -99,7 +99,7 @@ AUTH0_CLIENT_SECRET='<your-auth0-application-client-secret>'
9999
# OpenAI API Key or any provider supported by the Vercel AI SDK
100100
OPENAI_API_KEY="YOUR_API_KEY"
101101
```
102-
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 client application. You'll find these values in the **Basic Information** section at the top.
102+
To get your Auth0 application's `AUTH0_DOMAIN`, `AUTH0_CLIENT_ID`, and `AUTH0_CLIENT_SECRET`, navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/applications)</strong> in the Auth0 Dashboard and select your client application. You'll find these values in the **Basic Information** section at the top.
103103
Copy each value to the matching setting.
104104

105105
Next, run this command to generate a random 32 byte value and copy it to the `AUTH0_SECRET` field:

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ VITE_AUTH0_CLIENT_ID=your-spa-client-id
5353
VITE_AUTH0_AUDIENCE=your-api-identifier
5454
VITE_API_URL=http://localhost:3001
5555
```
56-
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.
56+
To get your SPA application's `VITE_AUTH0_DOMAIN`, and `VITE_AUTH0_CLIENT_ID`, navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/applications)</strong> in the Auth0 Dashboard and select your SPA application. You'll find these values in the **Basic Information** section at the top.
5757
Copy each value to the matching setting.
5858

59-
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.
59+
To get your API's `AUTH0_AUDIENCE`, navigate to <strong>[Applications > APIs](https://manage.auth0.com/#/apis)</strong> in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.
6060

6161
#### Server (server/.env)
6262

@@ -68,7 +68,7 @@ AUTH0_CUSTOM_API_CLIENT_SECRET=your-custom-api-client-secret
6868
OPENAI_API_KEY=your-openai-api-key
6969
PORT=3001
7070
```
71-
To get your Custom API Client's `AUTH0_DOMAIN`, `AUTH0_AUDIENCE`, and `AUTH0_CUSTOM_API_CLIENT_ID`, and `AUTH0_CUSTOM_API_CLIENT_SECRET` navigate to <strong>Applications > Applications </strong> in the Auth0 Dashboard and select your Custom API Client application. You'll find these values in the **Basic Information** section at the top.
71+
To get your Custom API Client's `AUTH0_DOMAIN`, `AUTH0_AUDIENCE`, and `AUTH0_CUSTOM_API_CLIENT_ID`, and `AUTH0_CUSTOM_API_CLIENT_SECRET` navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/applications)</strong> in the Auth0 Dashboard and select your Custom API Client application. You'll find these values in the **Basic Information** section at the top.
7272
Copy each value to the matching setting.
7373

7474
The `AUTH0_AUDIENCE` should match the identifier of the API referenced in the `client/.env` file above.
@@ -137,10 +137,10 @@ VITE_AUTH0_AUDIENCE=your-api-identifier
137137
VITE_API_URL=http://localhost:3001
138138
```
139139

140-
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.
140+
To get your SPA application's `VITE_AUTH0_DOMAIN`, and `VITE_AUTH0_CLIENT_ID`, navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/applications)</strong> in the Auth0 Dashboard and select your SPA application. You'll find these values in the **Basic Information** section at the top.
141141
Copy each value to the matching setting.
142142

143-
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.
143+
To get your API's `AUTH0_AUDIENCE`, navigate to <strong>[Applications > APIs](https://manage.auth0.com/#/apis)</strong> in the Auth0 Dashboard and select your API. You'll find the identifier in the **General Settings** section at the top.
144144

145145
#### Server (server/.env)
146146

@@ -152,7 +152,7 @@ AUTH0_CUSTOM_API_CLIENT_SECRET=your-custom-api-client-secret
152152
OPENAI_API_KEY=your-openai-api-key
153153
PORT=3001
154154
```
155-
To get your Custom API Client's `AUTH0_DOMAIN`, `AUTH0_AUDIENCE`, and `AUTH0_CUSTOM_API_CLIENT_ID`, and `AUTH0_CUSTOM_API_CLIENT_SECRET` navigate to <strong>Applications > Applications </strong> in the Auth0 Dashboard and select your Custom API Client application. You'll find these values in the **Basic Information** section at the top.
155+
To get your Custom API Client's `AUTH0_DOMAIN`, `AUTH0_AUDIENCE`, and `AUTH0_CUSTOM_API_CLIENT_ID`, and `AUTH0_CUSTOM_API_CLIENT_SECRET` navigate to <strong>[Applications > Applications](https://manage.auth0.com/#/applications)</strong> in the Auth0 Dashboard and select your Custom API Client application. You'll find these values in the **Basic Information** section at the top.
156156
Copy each value to the matching setting.
157157

158158
The `AUTH0_AUDIENCE` should match the identifier of the API referenced in the `client/.env` file above.

0 commit comments

Comments
 (0)