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 2 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
15 changes: 15 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,21 @@ backend.add(import('@pagerduty/backstage-plugin-backend'));

```

## Configure Backstage Backend API Authorization

By default, this plugin will allow any unauthenticated user to make calls using your PagerDuty API token.

You should consider carefully if this is appropriate in your production environment.

To disable this behaviour, you can set `pagerDuty.disableUnauthenticatedAccess` to true.

Example `app-config.yaml` excerpt:

```yaml
pagerduty:
disableUnauthenticatedAccess: true
```
Comment on lines 172 to 175
Copy link
Contributor

@jhfgloria jhfgloria Nov 4, 2025

Choose a reason for hiding this comment

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

Hello @jkueh! I reached out to you on another PR related to this matter. I think we should flip the enablement logic. It should be secure by default and less secure on demand. We would release a minor version to avoid people getting dragged by a changed like that on a patch version.


## 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