Skip to content

Updating default audience config values and logic #524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mchang16-auth merged 1 commit into from
Mar 12, 2025
Merged

Updating default audience config values and logic #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This can be done by renaming `auth_config.json.example` (https://github.com/auth
"domain": "YOUR_DOMAIN",
"clientId": "YOUR_CLIENT_ID",
"authorizationParams": {
"audience": "YOUR_API_IDENTIFIER",
"audience": "{yourApiIdentifier}",
},
"apiUri": "http://localhost:3001",
"appUri": "http://localhost:4200"
Expand Down
6 changes: 4 additions & 2 deletions Sample-01/api-server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ const app = express();
if (
!authConfig.domain ||
!authConfig.authorizationParams.audience ||
["YOUR_API_IDENTIFIER", "{API_IDENTIFIER}"].includes(authConfig.authorizationParams.audience)
['{yourApiIdentifier}', '{API_IDENTIFIER}'].includes(
authConfig.authorizationParams.audience
)
) {
console.log(
"Exiting: Please make sure that auth_config.json is in place and populated with valid domain and audience values"
'Exiting: Please make sure that auth_config.json is in place and populated with valid domain and audience values'
);

process.exit();
Expand Down
4 changes: 2 additions & 2 deletions Sample-01/src/app/pages/external-api/external-api.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div class="container mt-5">
<h1>External API</h1>

<div *ngIf="hasApiError" class="alert alert-danger" role="alert">
An error occured when trying to call the local API on port 3001. Ensure the local API is started using either `npm run dev` or `npm run
server:api`.
Expand All @@ -20,7 +20,7 @@ <h1>External API</h1>
<p>
You can't call the API at the moment because your application does not
have any configuration for <code>audience</code>, or it is using the
default value of <code>YOUR_API_IDENTIFIER</code>. You might get this
default value of <code>&#123;yourApiIdentifier&#125;</code>. You might get this
default value if you used the "Download Sample" feature of
<a href="https://auth0.com/docs/quickstart/spa/angular">
Copy link
Contributor Author

@mchang16-auth mchang16-auth Feb 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I had to use the HTML characters for {}, as it was considering the brackets as JSX and causing the tests to fail.

the quickstart guide </a
Expand Down
2 changes: 1 addition & 1 deletion Sample-01/src/environments/environment.prod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export const environment = {
auth: {
domain,
clientId,
...(audience && audience !== "YOUR_API_IDENTIFIER" ? { audience } : null),
...(audience && audience !== "{yourApiIdentifier}" ? { audience } : null),
redirectUri: window.location.origin,
errorPath,
},
Expand Down
2 changes: 1 addition & 1 deletion Sample-01/src/environments/environment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export const environment = {
domain,
clientId,
authorizationParams: {
...(audience && audience !== 'YOUR_API_IDENTIFIER' ? { audience } : null),
...(audience && audience !== '{yourApiIdentifier}' ? { audience } : null),
redirect_uri: window.location.origin,
},
errorPath,
Expand Down
6 changes: 4 additions & 2 deletions Standalone/api-server.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@ const app = express();
if (
!authConfig.domain ||
!authConfig.authorizationParams.audience ||
["YOUR_API_IDENTIFIER", "{API_IDENTIFIER}"].includes(authConfig.authorizationParams.audience)
['{yourApiIdentifier}', '{API_IDENTIFIER}'].includes(
authConfig.authorizationParams.audience
)
) {
console.log(
"Exiting: Please make sure that auth_config.json is in place and populated with valid domain and audience values"
'Exiting: Please make sure that auth_config.json is in place and populated with valid domain and audience values'
);

process.exit();
Expand Down
4 changes: 2 additions & 2 deletions Standalone/src/app/pages/external-api/external-api.component.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div class="container mt-5">
<h1>External API</h1>

<div *ngIf="hasApiError" class="alert alert-danger" role="alert">
An error occured when trying to call the local API on port 3001. Ensure the local API is started using either `npm run dev` or `npm run
server:api`.
Expand All @@ -20,7 +20,7 @@ <h1>External API</h1>
<p>
You can't call the API at the moment because your application does not
have any configuration for <code>audience</code>, or it is using the
default value of <code>YOUR_API_IDENTIFIER</code>. You might get this
default value of <code>&#123;yourApiIdentifier&#125;</code>. You might get this
default value if you used the "Download Sample" feature of
<a href="https://auth0.com/docs/quickstart/spa/angular">
the quickstart guide </a
Expand Down
2 changes: 1 addition & 1 deletion Standalone/src/environments/environment.prod.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export const environment = {
auth: {
domain,
clientId,
...(audience && audience !== "YOUR_API_IDENTIFIER" ? { audience } : null),
...(audience && audience !== "{yourApiIdentifier}" ? { audience } : null),
redirectUri: window.location.origin,
errorPath,
},
Expand Down
2 changes: 1 addition & 1 deletion Standalone/src/environments/environment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export const environment = {
domain,
clientId,
authorizationParams: {
...(audience && audience !== 'YOUR_API_IDENTIFIER' ? { audience } : null),
...(audience && audience !== '{yourApiIdentifier}' ? { audience } : null),
redirect_uri: window.location.origin,
},
errorPath,
Expand Down