diff --git a/docs/integrations/github/email.png b/docs/integrations/github/email.png new file mode 100644 index 0000000000..6a39938eec Binary files /dev/null and b/docs/integrations/github/email.png differ diff --git a/docs/integrations/github/org.md b/docs/integrations/github/org.md index 4a1bf88932..5ee650e29c 100644 --- a/docs/integrations/github/org.md +++ b/docs/integrations/github/org.md @@ -53,6 +53,16 @@ catalog: token: ${GITHUB_TOKEN} ``` +If Backstage is configured to use GitHub Apps authentication you must grant +`Read-Only` access for `Members` under `Organization` in order to ingest users +correctly. You can modify the app's permissions under the organization settings, +`https://github.com/organizations/{ORG}/settings/apps/{APP_NAME}/permissions`. +![permissions](./permissions.png) + +**Please note that when you change permissions, the app owner will get an email +that must be approved first before the changes are applied.** +![email](./email.png) + Locations point out the specific org(s) you want to import. The `type` of these locations must be `github-org`, and the `target` must point to the exact URL of some organization. You can have several such location entries if you want, but diff --git a/docs/integrations/github/permissions.png b/docs/integrations/github/permissions.png new file mode 100644 index 0000000000..78883ee206 Binary files /dev/null and b/docs/integrations/github/permissions.png differ