docs icon indicating copy to clipboard operation
docs copied to clipboard

Update permissions-required-for-github-apps.md

Open mcfluffinstein opened this issue 3 years ago • 3 comments

Adjusting permissions after feedback on https://github.com/github/external-identities/issues/2534.

Why:

It's not possible for GitHub Apps to access these endpoints without write permissions. This is a known bug with querying SAML/SCIM identities with Read only permissions for members. https://github.com/github/external-identities/issues/2534. We won't have a bug fix for this out any time soon, so the engineering team responsible for it asked if I could raise a docs PR.

https://github.com/github/external-identities/issues/2534

What's being changed (if available, include any code snippets, screenshots, or gifs):

I'm updating the permissions required for GitHub Apps to access GET /scim/v2/orgs/:org/Users and GET /scim/v2/orgs/:org/Users/:external_identity_guid. Both of these endpoints require Members write permissions as highlighted on the issue.

- [`GET /scim/v2/orgs/:org/Users`](/rest/reference/scim#list-scim-provisioned-identities) (:read)
+ [`GET /scim/v2/orgs/:org/Users`](/rest/reference/scim#list-scim-provisioned-identities) (:write)

and

- [`GET /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#get-scim-provisioning-information-for-a-user) (:read)
+ [`GET /scim/v2/orgs/:org/Users/:external_identity_guid`](/rest/reference/scim#get-scim-provisioning-information-for-a-user) (:write)

Check off the following:

  • [ ] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [X] For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • [ ] This pull request impacts the contribution experience
    • [ ] I have added the 'writer impact' label
    • [ ] I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

mcfluffinstein avatar Aug 10 '22 08:08 mcfluffinstein

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Aug 10 '22 08:08 welcome[bot]

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
rest/overview/permissions-required-for-github-apps.md fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae
fpt
ghec
ghes@ 3.6 3.5 3.4 3.3 3.2
ghae

fpt: Free, Pro, Team ghec: GitHub Enterprise Cloud ghes: GitHub Enterprise Server ghae: GitHub AE

github-actions[bot] avatar Aug 10 '22 08:08 github-actions[bot]

👋 @mcfluffinstein Thanks so much for opening a PR! I'll get this triaged for review :zap:

cmwilson21 avatar Aug 10 '22 19:08 cmwilson21

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues :zap:

github-actions[bot] avatar Aug 12 '22 21:08 github-actions[bot]