我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

此版本的 GitHub Enterprise 将停止服务 此版本的 GitHub Enterprise 已停止服务 2020-08-20. 即使针对重大安全问题,也不会发布补丁。 要获得更好的性能、改进的安全性和新功能,请升级到 GitHub Enterprise 的最新版本。 如需升级方面的帮助,请联系 GitHub Enterprise 支持

文章版本: Enterprise Server 2.18

为用户发现资源

了解如何通过向 REST API 发出经过身份验证的请求,找到您的应用程序能够为用户可靠地访问的仓库和组织。

本文内容

Did this doc help you?

向 GitHub Enterprise API 发出经过身份验证的请求时,应用程序通常需要获取当前用户的仓库和组织。 在本指南中,我们将介绍如何可靠地发现这些资源。

为了与 GitHub Enterprise API 进行交互,我们将使用 Octokit.rb。 您可以在平台样本仓库中找到此项目的完整源代码。

入门指南

在完成以下示例之前,您应该阅读“身份验证基础知识”指南(如果尚未阅读)。 下面的示例假定您已注册 OAuth 应用程序,并且您的应用程序具有用户的 OAuth 令牌

发现您的应用程序能够为用户访问的仓库

用户除了拥有他们自己的个人仓库之外,可能还是其他用户和组织所拥有仓库上的协作者。 总的来说,这些仓库是用户有权访问的仓库:要么是用户具有读取或写入权限的私有仓库,要么是用户具有写入权限的公共仓库。

OAuth 作用域组织应用程序策略决定了您的应用程序可以为用户访问其中哪些仓库。 使用下面的工作流程来发现这些仓库。

如往常一样,首先我们需要 GitHub 的 Octokit.rb Ruby 库。 然后我们将配置 Octoberkit.rb,使其为我们自动处理分页

require 'octokit'

Octokit.auto_paginate = true

接下来,我们将为给定用户传递应用程序的 OAuth 令牌

# !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!!
# Instead, set and test environment variables, like below.
client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"]

然后,我们可以获取应用程序可以为用户访问的仓库

client.repositories.each do |repository|
  full_name = repository[:full_name]
  has_push_access = repository[:permissions][:push]

  access_type = if has_push_access
                  "write"
                else
                  "read-only"
                end

  puts "User has #{access_type} access to #{full_name}."
end

发现您的应用程序能够为用户访问的组织

应用程序可以为用户执行各种与组织相关的任务。 要执行这些任务,应用程序需要具有足够权限的 OAuth 授权。 例如,read:org 作用域允许您列出团队user 作用域允许您公开用户的组织成员身份。 一旦用户将其中一个或多个作用域授予您的应用程序,您就可以获取用户的组织。

与上述发现仓库的过程一样,我们首先需要 GitHub 的 Octokit.rb Ruby 库,并配置它为我们处理分页

require 'octokit'

Octokit.auto_paginate = true

接下来,我们将为给定用户传递应用程序的 OAuth 令牌,以初始化 API 客户端:

# !!! DO NOT EVER USE HARD-CODED VALUES IN A REAL APP !!!
# Instead, set and test environment variables, like below.
client = Octokit::Client.new :access_token => ENV["OAUTH_ACCESS_TOKEN"]

然后,我们可以获取应用程序可以为用户访问的组织

client.organizations.each do |organization|
  puts "User belongs to the #{organization[:login]} organization."
end

不要依赖公共组织

如果您从头到尾阅读了文档,您可能会注意到一种允许列出用户的公共组织成员身份的 API 方法。 大多数应用程序应避免使用这种 API 方法。 此方法仅返回用户的公共组织成员身份,而不会返回其私有组织成员身份。

作为应用程序开发者,您通常希望您的应用程序被授权访问用户的所有组织(公共和私有)。 上述工作流程恰好能满足您的要求。

Did this doc help you?

问问别人

找不到要找的内容?

联系我们