Skip to content

Commit c021e4a

Browse files
committed
chore(readme): update information on the required scopes for checking for teams
1 parent 397d3fb commit c021e4a

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,16 @@ whitelist:
9898
- 988772
9999
```
100100
101+
### OAuth Configuration
102+
103+
For the OAuth configuration, you need to create a GitHub OAuth App.
104+
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.
105+
106+
#### OAuth Scopes
107+
- For `ids` and `logins` you don't need extra scopes.
108+
- 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).
109+
110+
101111
## License
102112

103113
[MIT](./LICENSE)

0 commit comments

Comments
 (0)