Skip to content

doc: Add section on authorization on the Backstage Backend API #14

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
jhfgloria merged 3 commits into from
Nov 5, 2025
Merged

doc: Add section on authorization on the Backstage Backend API #14

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed11560
doc: Add section on authorization on the Backstage Backend API
jkueh Jul 25, 2025
d4c322d
Merge branch 'main' into main
jkueh Sep 4, 2025
022b6a6
Updating documentation to reflect this option now being an opt-in
jkueh Nov 5, 2025
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
18 changes: 18 additions & 0 deletions docs/getting-started/backstage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,24 @@ backend.add(import('@pagerduty/backstage-plugin-backend'));

```

## Disable Backstage Backend API Authorization

This option is available as a way to maintain backwards compatibility, and should not be used in situations where your
Backstage instance is accessible from outside of a trusted network - Or ideally, at all.

Access to a Backstage plugin's routes is restricted by use of a Bearer authorization token, which is typically issued
after successfully signing in to Backstage.

Previous versions of this plugin had this behaviour disabled. Restoring this previous behaviour is now opt-in, and can
be achieved by setting `pagerduty.enableUnauthenticatedAccess` to `true`.

Example `app-config.yaml` excerpt:

```yaml
pagerduty:
enableUnauthenticatedAccess: true
```

## Configure API Authorization

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.
Expand Down