Skip to content

Commit ac8f3fc

Browse files
authored
Merge pull request #14 from jkueh/main
doc: Add section on authorization on the Backstage Backend API
2 parents 1138c71 + 022b6a6 commit ac8f3fc

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

docs/getting-started/backstage.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,24 @@ backend.add(import('@pagerduty/backstage-plugin-backend'));
156156
157157
```
158158

159+
## Disable Backstage Backend API Authorization
160+
161+
This option is available as a way to maintain backwards compatibility, and should not be used in situations where your
162+
Backstage instance is accessible from outside of a trusted network - Or ideally, at all.
163+
164+
Access to a Backstage plugin's routes is restricted by use of a Bearer authorization token, which is typically issued
165+
after successfully signing in to Backstage.
166+
167+
Previous versions of this plugin had this behaviour disabled. Restoring this previous behaviour is now opt-in, and can
168+
be achieved by setting `pagerduty.enableUnauthenticatedAccess` to `true`.
169+
170+
Example `app-config.yaml` excerpt:
171+
172+
```yaml
173+
pagerduty:
174+
enableUnauthenticatedAccess: true
175+
```
176+
159177
## Configure API Authorization
160178

161179
The PagerDuty plugin requires access to PagerDuty APIs and so we need to configure our Backstage app with the necessary credentials to reach the APIs. This step requires you to use an access token - for OAuth - or an API token.

0 commit comments

Comments
 (0)