Skip to content

Commit cf38116

Browse files
authored
Merge pull request #1035 from DuendeSoftware/ar/bff-mf-config-fix
Updated BFF Multi-Frontend doc to include "remoteApis" JSON sample
2 parents e6fe5e8 + 1afdd38 commit cf38116

1 file changed

Lines changed: 18 additions & 10 deletions

File tree

astro/src/content/docs/bff/fundamentals/multi-frontend/configuration.mdx

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar:
77
---
88

99
It's possible to configure frontends for the BFF via `IConfiguration`. This enables dynamic loading / changing of frontends,
10-
including their OpenID Connect configuration and BFF Configuration.
10+
including their OpenID Connect configuration, BFF Configuration, and Remote APIs.
1111

1212
```csharp {5}
1313
var bffConfig = new ConfigurationBuilder()
@@ -24,15 +24,15 @@ The configuration supports dynamic reloading (so any new frontend added / remove
2424

2525
- `defaultOidcSettings`
2626
OIDC settings applied globally to all frontends unless overridden.
27-
Type: OidcConfiguration object (see below for properties).
27+
Type: OidcConfiguration object ([see below](#oidcconfiguration-json-properties)).
2828

2929
- `defaultCookieSettings`
3030
Cookie settings applied globally to all frontends unless overridden.
31-
Type: CookieConfiguration object (properties depend on your implementation).
31+
Type: CookieConfiguration object ([see below](#cookieconfiguration-json-properties)).
3232

3333
- `frontends`
3434
Dictionary of frontend configurations.
35-
Each key is a frontend name, and the value is a BffFrontendConfiguration object (see below).
35+
Each key is a frontend name, and the value is a BffFrontendConfiguration object ([see below](#bfffrontendconfiguration-json-properties)).
3636

3737
---
3838

@@ -61,14 +61,15 @@ The configuration supports dynamic reloading (so any new frontend added / remove
6161

6262
- `oidc`
6363
OIDC settings specific to this frontend.
64-
Type: OidcConfiguration object (see below).
64+
Type: OidcConfiguration object ([see below](#oidcconfiguration-json-properties)).
6565

6666
- `cookies`
6767
Cookie settings specific to this frontend.
68-
Type: CookieConfiguration object (see below)
68+
Type: CookieConfiguration object ([see below](#cookieconfiguration-json-properties)).
6969

7070
- `remoteApis`
71-
Remote APIs for this frontend. (see below)
71+
Remote APIs for this frontend.
72+
Type: RemoteApiConfiguration object. ([see below](#remoteapiconfiguration-json-properties)).
7273

7374
### RemoteApiConfiguration JSON Properties
7475

@@ -89,7 +90,7 @@ The configuration supports dynamic reloading (so any new frontend added / remove
8990
String. The type name of the access token retriever to use for this remote API.
9091

9192
- `userAccessTokenParameters`
92-
Object. Parameters for retrieving a user access token (see below).
93+
Object. Parameters for retrieving a user access token ([see below](#useraccesstokenparameters-json-properties)).
9394

9495
- `activityTimeout`
9596
String. How long a request is allowed to remain idle between operations before being canceled.
@@ -157,7 +158,7 @@ The configuration supports dynamic reloading (so any new frontend added / remove
157158
Boolean. Indicates whether the cookie is inaccessible by client-side script. Defaults to true.
158159

159160
- `sameSite`
160-
String. The SameSite attribute of the cookie. Defaults to strictg.
161+
String. The SameSite attribute of the cookie. Defaults to `"Strict"`.
161162
Possible values: `"None"`, `"Lax"`, `"Strict"`
162163

163164
- `securePolicy`
@@ -195,7 +196,14 @@ The configuration supports dynamic reloading (so any new frontend added / remove
195196
"oidc": {
196197
"clientId": "frontend1-client",
197198
"scope": ["openid", "profile", "email"]
198-
}
199+
},
200+
"remoteApis": [
201+
{
202+
"pathMatch": "/todos",
203+
"targetUri": "https://localhost:5020/todos/",
204+
"requiredTokenType": "User"
205+
}
206+
]
199207
}
200208
}
201209
}

0 commit comments

Comments
 (0)