paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 41 Packages Projects Releases Wiki Activity

docs updates

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2024-05-07 12:40:26 +02:00
parent 88480e4ef2
commit f612f630ed
3 changed files with 24 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/proxy-backend/config.d.ts
Vendored
+16 -6
View File
@@ -88,6 +88,11 @@ export interface Config {
* are required to access this proxy target. The target can still
* apply its own credentials checks, but the proxy will not help
* block non-Backstage-blessed callers.
*
* Note that if you have
* `backend.auth.dangerouslyDisableDefaultAuthPolicy` set to `true`,
* the `credentials` value does not apply; the proxy will behave as
* if all endpoints were set to `dangerously-allow-unauthenticated`.
*/
credentials?:
| 'require'
@@ -151,15 +156,20 @@ export interface Config {
* The values are as follows:
*
* - 'require': Callers must provide Backstage user or service
* credentials with each request. The credentials are not
* forwarded to the proxy target.
* credentials with each request. The credentials are not forwarded
* to the proxy target.
* - 'forward': Callers must provide Backstage user or service
* credentials with each request, and those credentials are
* forwarded to the proxy target.
* - 'dangerously-allow-unauthenticated': No Backstage credentials
* are required to access this proxy target. The target can still
* apply its own credentials checks, but the proxy will not help
* block non-Backstage-blessed callers.
* - 'dangerously-allow-unauthenticated': No Backstage credentials are
* required to access this proxy target. The target can still apply
* its own credentials checks, but the proxy will not help block
* non-Backstage-blessed callers.
*
* Note that if you have
* `backend.auth.dangerouslyDisableDefaultAuthPolicy` set to `true`,
* the `credentials` value does not apply; the proxy will behave as if
* all endpoints were set to `dangerously-allow-unauthenticated`.
*/
credentials?:
| 'require'