When an application like Stoplight authenticates with Github, specific permissions are required in order to enable certain functionality. The permissions required are discussed below.
Stoplight requires the following OAuth scopes when authenticating with your Github account:
-
read:org Read org and team membership, read org projects
-
read:user Read all user profile data
- user:email Access user email addresses (read-only)
Each scope is described in more detail below. For more information on OAuth scopes in Github, please consult the Github documentation available here.
Why do you need to read org and team membership?
Stoplight requires read:org access to your organization and team membership to recognize which repositories you and other users in your organization have access to. This allows Stoplight Studio to discern who can publish to a certain repository, who sees which models/endpoints, and who can view your published documentation.
Why do you need to read my user profile data?
Stoplight requires read:user access to your user profile data in order to know which organizations you are a member of.
Why do you need full control of private repositories?
The repo scope requirement was removed with Stoplight v1.5.0.
Stoplight requires repo access to private repositories in order to push and pull data from projects that live under your personal Github account (as opposed to an organization).
Why do you need to access my user email address?
Stoplight requires user:email access to the email addresses attached to your account so that we can connect any other accounts in Stoplight that may have already been created under a different email address.