Skip to content

Commit

Permalink
chore(readme): update information on the required scopes for checking…
Browse files Browse the repository at this point in the history
… for teams
  • Loading branch information
luizfonseca committed Dec 30, 2024
1 parent 397d3fb commit c021e4a
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,16 @@ whitelist:
- 988772
```
### OAuth Configuration
For the OAuth configuration, you need to create a GitHub OAuth App.
You can follow the steps in the [GitHub documentation](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) to create it and obtain the `GITHUB_OAUTH_CLIENT_ID` and `GITHUB_OAUTH_CLIENT_SECRET` values.

#### OAuth Scopes
- For `ids` and `logins` you don't need extra scopes.
- For `teams` you will need to request the `read:org`, `user` or `repo` scopes from the user. See the [documentation](https://docs.github.com/en/rest/teams/teams?apiVersion=2022-11-28#list-teams-for-the-authenticated-user).


## License

[MIT](./LICENSE)

0 comments on commit c021e4a

Please sign in to comment.