REST API 现在已分版本。 更多信息，请参阅“关于 API 版本控制”。

Codespaces 组织密钥的 REST API 端点

使用 REST API 管理您组织级别的 Codespaces 密钥。

注意

这些端点目前处于公开预览阶段，可能会发生更改。

列出组织密钥

列出组织级别可用的所有 Codespaces 开发环境密钥，而不会泄露其加密值。

OAuth 应用令牌和个人访问令牌（传统）需要 `admin:org` 范围才能使用此端点。

“列出组织密钥”的细粒度访问令牌

此端点可以使用以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “组织 Codespaces 密钥”组织权限（读取）

“列出组织密钥”的参数

Headers
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

查询参数
per_page 整数

每页结果数（最大 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认值：30

page 整数

要提取的结果页码。更多信息，请参阅“在 REST API 中使用分页”。

默认值：1

“列出组织密钥”的 HTTP 响应状态代码

状态码描述
200

OK

“列出组织密钥”的代码示例

请求示例

get/orgs/{org}/codespaces/secrets
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets

响应

状态：200
{ "total_count": 2, "secrets": [ { "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" }, { "name": "GIST_ID", "created_at": "2020-01-10T10:59:22Z", "updated_at": "2020-01-11T11:59:22Z", "visibility": "all" } ] }

获取组织公钥

获取组织的公钥，这是加密密钥所必需的。在创建或更新密钥之前，您需要先加密密钥的值。OAuth 应用令牌和个人访问令牌（传统）需要 `admin:org` 范围才能使用此端点。

“获取组织公钥”的细粒度访问令牌

此端点可以使用以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “组织 Codespaces 密钥”组织权限（读取）

“获取组织公钥”的参数

Headers
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

“获取组织公钥”的 HTTP 响应状态代码

状态码描述
200

OK

“获取组织公钥”的代码示例

请求示例

get/orgs/{org}/codespaces/secrets/public-key
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/public-key

响应

状态：200
{ "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" }

获取组织密钥

获取组织开发环境密钥，而不会泄露其加密值。

OAuth 应用令牌和个人访问令牌（传统）需要 `admin:org` 范围才能使用此端点。

“获取组织密钥”的细粒度访问令牌

此端点可以使用以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “组织 Codespaces 密钥”组织权限（读取）

“获取组织密钥”的参数

Headers
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

secret_name 字符串 必填

密钥的名称。

“获取组织密钥”的 HTTP 响应状态代码

状态码描述
200

OK

“获取组织密钥”的代码示例

请求示例

get/orgs/{org}/codespaces/secrets/{secret_name}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME

响应

状态：200
{ "name": "GH_TOKEN", "created_at": "2019-08-10T14:59:22Z", "updated_at": "2020-01-10T14:59:22Z", "visibility": "all" }

创建或更新组织密钥

使用加密值创建或更新组织开发环境密钥。使用 LibSodium 加密您的密钥。更多信息，请参阅“为 REST API 加密密钥”。

OAuth 应用令牌和个人访问令牌（传统）需要 `admin:org` 范围才能使用此端点。

“创建或更新组织密钥”的细粒度访问令牌

此端点可以使用以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “组织 Codespaces 密钥”组织权限（写入）

“创建或更新组织密钥”的参数

Headers
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

secret_name 字符串 必填

密钥的名称。

正文参数
encrypted_value 字符串

您的密钥的值，使用 LibSodium 和从 获取组织公钥 端点检索到的公钥加密。

key_id 字符串

用于加密密钥的密钥的 ID。

visibility 字符串 必填

哪些类型的组织仓库可以访问组织机密。selected 表示只有由 selected_repository_ids 指定的仓库才能访问机密。

可以是以下之一：all，private，selected

selected_repository_ids 整数数组

可以访问组织机密的仓库 ID 数组。只有当 visibility 设置为 selected 时，才能提供仓库 ID 列表。您可以使用 列出组织机密的已选仓库、设置组织机密的已选仓库 和 从组织机密中移除已选仓库 端点管理已选仓库列表。

“创建或更新组织机密”的 HTTP 响应状态码

状态码描述
201

创建机密时的响应

204

更新机密时的响应

404

资源未找到

422

验证失败，或端点已被滥用。

“创建或更新组织机密”的代码示例

请求示例

put/orgs/{org}/codespaces/secrets/{secret_name}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME \ -d '{"encrypted_value":"c2VjcmV0","key_id":"012345678912345678","visibility":"selected","selected_repository_ids":[1296269,1296280]}'

创建机密时的响应

状态：201

删除组织机密

使用机密名称删除组织开发环境机密。

OAuth 应用令牌和个人访问令牌（传统）需要 `admin:org` 范围才能使用此端点。

“删除组织机密”的细粒度访问令牌

此端点可以使用以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “组织 Codespaces 密钥”组织权限（写入）

“删除组织机密”的参数

Headers
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

secret_name 字符串 必填

密钥的名称。

“删除组织机密”的 HTTP 响应状态码

状态码描述
204

无内容

404

资源未找到

“删除组织机密”的代码示例

请求示例

delete/orgs/{org}/codespaces/secrets/{secret_name}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME

响应

状态：204

列出组织机密的已选仓库

列出当仓库访问机密的visibility设置为selected时所有已选择的仓库。

OAuth 应用令牌和个人访问令牌（传统）需要 `admin:org` 范围才能使用此端点。

“列出组织机密的已选仓库”的细粒度访问令牌

此端点可以使用以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “组织 Codespaces 密钥”组织权限（读取）

“列出组织机密的已选仓库”的参数

Headers
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

secret_name 字符串 必填

密钥的名称。

查询参数
page 整数

要提取的结果页码。更多信息，请参阅“在 REST API 中使用分页”。

默认值：1

per_page 整数

每页结果数（最大 100）。更多信息，请参阅“在 REST API 中使用分页”。

默认值：30

“列出组织机密的已选仓库”的 HTTP 响应状态码

状态码描述
200

OK

404

资源未找到

“列出组织机密的已选仓库”的代码示例

请求示例

get/orgs/{org}/codespaces/secrets/{secret_name}/repositories
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME/repositories

响应

状态：200
{ "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] }

设置组织机密的已选仓库

当仓库访问的visibility设置为selected时，替换组织开发环境机密的所有仓库。当您创建或更新组织机密时，会设置可见性。

OAuth 应用令牌和个人访问令牌（传统）需要 `admin:org` 范围才能使用此端点。

“设置组织机密的已选仓库”的细粒度访问令牌

此端点可以使用以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “组织 Codespaces 密钥”组织权限（写入）

“设置组织机密的已选仓库”的参数

Headers
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

secret_name 字符串 必填

密钥的名称。

正文参数
selected_repository_ids 整数数组 必填

可以访问组织机密的仓库 ID 数组。只有当 visibility 设置为 selected 时，才能提供仓库 ID 列表。您可以使用 设置组织机密的已选仓库 和 从组织机密中移除已选仓库 端点添加和删除单个仓库。

“设置组织机密的已选仓库”的 HTTP 响应状态码

状态码描述
204

无内容

404

资源未找到

409

可见性类型未设置为 selected 时发生冲突

“设置组织机密的已选仓库”的代码示例

请求示例

put/orgs/{org}/codespaces/secrets/{secret_name}/repositories
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME/repositories \ -d '{"selected_repository_ids":[64780797]}'

响应

状态：204

向组织机密添加已选仓库

当仓库访问的visibility设置为selected时，将仓库添加到组织开发环境机密。当您创建或更新组织机密时，会设置可见性。OAuth 应用令牌和个人访问令牌（传统）需要admin:org作用域才能使用此端点。

“向组织机密添加已选仓库”的细粒度访问令牌

此端点可以使用以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “组织代码空间机密”组织权限（写入）和“元数据”仓库权限（读取）

“向组织机密添加已选仓库”的参数

Headers
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

secret_name 字符串 必填

密钥的名称。

repository_id 整数 必填

“向组织机密添加已选仓库”的 HTTP 响应状态码

状态码描述
204

将仓库添加到已选列表时，无内容

404

资源未找到

409

可见性类型未设置为 selected 时发生冲突

422

验证失败，或端点已被滥用。

“向组织机密添加已选仓库”的代码示例

请求示例

put/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME/repositories/REPOSITORY_ID

将仓库添加到已选列表时，无内容

状态：204

从组织机密中移除已选仓库

当仓库访问的visibility设置为selected时，从组织开发环境机密中移除仓库。当您创建或更新组织机密时，会设置可见性。

OAuth 应用令牌和个人访问令牌（传统）需要 `admin:org` 范围才能使用此端点。

“从组织机密中移除已选仓库”的细粒度访问令牌

此端点可以使用以下细粒度令牌类型:

细粒度令牌必须具有以下权限集

  • “组织代码空间机密”组织权限（写入）和“元数据”仓库权限（读取）

“从组织机密中移除已选仓库”的参数

Headers
accept 字符串

建议设置为 `application/vnd.github+json`。

路径参数
org 字符串 必填

组织名称。名称不区分大小写。

secret_name 字符串 必填

密钥的名称。

repository_id 整数 必填

“从组织机密中移除已选仓库”的 HTTP 响应状态码

状态码描述
204

从已选列表中移除仓库时的响应

404

资源未找到

409

可见性类型未设置为 selected 时发生冲突

422

验证失败，或端点已被滥用。

“从组织机密中移除已选仓库”的代码示例

请求示例

delete/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME/repositories/REPOSITORY_ID

从已选列表中移除仓库时的响应

状态：204