Skip to main content

Authorizing OAuth Apps

You can connect your GitHub Enterprise Cloud identity to third-party applications using OAuth. When authorizing an OAuth 应用程序, you should ensure you trust the application, review who it's developed by, and review the kinds of information the application wants to access.

When an OAuth 应用程序 wants to identify you by your account on, you'll see a page with the app's developer contact information and a list of the specific data that's being requested.

Tip: You must verify your email address before you can authorize an OAuth 应用程序.

OAuth 应用程序 access

OAuth 应用程序 can have read or write access to your GitHub Enterprise Cloud data.

  • Read access only allows an app to look at your data.
  • Write access allows an app to change your data.

Tip: 我们建议您定期审查您授权的集成。 删除在一段时间内未使用的任何应用程序和令牌。 更多信息请参阅“>审查授权的集成”。

About OAuth scopes

Scopes are named groups of permissions that an OAuth 应用程序 can request to access both public and non-public data.

When you want to use an OAuth 应用程序 that integrates with GitHub Enterprise Cloud, that app lets you know what type of access to your data will be required. If you grant access to the app, then the app will be able to perform actions on your behalf, such as reading or modifying data. For example, if you want to use an app that requests user:email scope, the app will have read-only access to your private email addresses. For more information, see "About scopes for OAuth 应用程序."

Note: Currently, you can't scope source code access to read-only.

每个用户/应用程序/作用域组合签发的令牌数量有限。 如果应用程序为同一用户和相同作用域创建超过 10 个令牌,则将吊销具有相同用户/应用程序/作用域组合的最旧令牌。

Types of requested data

OAuth 应用程序 can request several types of data.

Type of dataDescription
Commit statusYou can grant access for an app to report your commit status. Commit status access allows apps to determine if a build is a successful against a specific commit. Apps won't have access to your code, but they can read and write status information against a specific commit.
DeploymentsDeployment status access allows apps to determine if a deployment is successful against a specific commit for public and private repositories. Apps won't have access to your code.
GistsGist access allows apps to read or write to both your public and secret Gists.
HooksWebhooks access allows apps to read or write hook configurations on repositories you manage.
NotificationsNotification access allows apps to read your GitHub Enterprise Cloud notifications, such as comments on issues and pull requests. However, apps remain unable to access anything in your repositories.
Organizations and teamsOrganization and teams access allows apps to access and manage organization and team membership.
Personal user dataUser data includes information found in your user profile, like your name, e-mail address, and location.
RepositoriesRepository information includes the names of contributors, the branches you've created, and the actual files within your repository. Apps can request access for either public or private repositories on a user-wide level.
Repository deleteApps can request to delete repositories that you administer, but they won't have access to your code.
ProjectsAccess to user and organization projects (beta). Apps can request either read/write or read only access.

Requesting updated permissions

When OAuth 应用程序 request new access permissions, they will notify you of the differences between their current permissions and the new permissions.

OAuth 应用程序 and organizations

When you authorize an OAuth 应用程序 for your personal account, you'll also see how the authorization will affect each organization you're a member of.

  • For organizations with OAuth 应用程序 access restrictions, you can request that organization admins approve the application for use in that organization. If the organization does not approve the application, then the application will only be able to access the organization's public resources. If you're an organization admin, you can approve the application yourself.

  • For organizations without OAuth 应用程序 access restrictions, the application will automatically be authorized for access to that organization's resources. For this reason, you should be careful about which OAuth 应用程序 you approve for access to your personal account resources as well as any organization resources.

If you belong to any organizations that enforce SAML single sign-on, you must have an active SAML session for each organization each time you authorize an OAuth 应用程序.

Note: If you are encountering errors authenticating to an organization that enforces SAML single sign-on, you may need to revoke the OAuth App from your account settings page and repeat the authentication flow to reauthorize the app.

Further reading