Codespaces 组织秘密的 REST API 端点

注意：这些端点目前处于公开测试阶段，可能会发生变化。

列出组织秘密

列出组织级别可用的所有 Codespaces 开发环境秘密，但不显示其加密值。

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

用于“列出组织秘密”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

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

"组织代码空间秘密" 组织权限（读取）

"列出组织秘密" 的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。

查询参数
名称、类型、描述
`per_page` integer 每页结果数（最大 100）。有关更多信息，请参阅 "在 REST API 中使用分页"。默认: `30`
`page` integer 要获取的结果页码。有关更多信息，请参阅 "在 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 范围才能使用此端点。

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

此端点适用于以下细粒度令牌类型

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

"组织代码空间秘密" 组织权限（读取）

"获取组织公钥" 的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。

获取组织公钥的 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 范围才能使用此端点。

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

此端点适用于以下细粒度令牌类型

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

"组织代码空间秘密" 组织权限（读取）

获取组织密钥的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`secret_name` string 必需密钥的名称。

获取组织密钥的 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 范围才能使用此端点。

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

此端点适用于以下细粒度令牌类型

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

“组织代码空间密钥”组织权限（写入）

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

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`secret_name` string 必需密钥的名称。

主体参数
名称、类型、描述
`encrypted_value` string 您的密钥的值，使用 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 范围才能使用此端点。

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

此端点适用于以下细粒度令牌类型

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

“组织代码空间密钥”组织权限（写入）

“删除组织机密”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`secret_name` string 必需密钥的名称。

“删除组织机密”的 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 范围才能使用此端点。

用于“列出组织机密的选定存储库”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

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

"组织代码空间秘密" 组织权限（读取）

“列出组织机密的选定存储库”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`secret_name` string 必需密钥的名称。

查询参数
名称、类型、描述
`page` integer 要获取的结果页码。有关更多信息，请参阅 "在 REST API 中使用分页"。默认: `1`
`per_page` integer 每页结果数（最大 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 范围才能使用此端点。

用于“设置组织机密的选定存储库”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

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

“组织代码空间密钥”组织权限（写入）

“设置组织机密的选定存储库”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`secret_name` string 必需密钥的名称。

主体参数
名称、类型、描述
`selected_repository_ids` 整数数组必需可以访问组织机密的存储库 ID 数组。只有当`visibility`设置为`selected`时，您才能提供存储库 ID 列表。您可以使用设置组织机密的选定存储库和从组织机密中删除选定存储库端点添加和删除单个存储库。

为组织机密设置选定仓库的 HTTP 响应状态码

状态代码	描述
`204`	无内容
`404`	资源未找到
`409`	当可见性类型未设置为已选时发生冲突

为“设置组织机密的选定仓库”提供代码示例

请求示例

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范围才能使用此端点。

为“将选定仓库添加到组织机密”提供细粒度访问令牌

此端点适用于以下细粒度令牌类型

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

"组织 codespaces 机密" 组织权限（写入）和 "元数据" 仓库权限（读取）

为“将选定仓库添加到组织机密”提供参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`secret_name` string 必需密钥的名称。
`repository_id` integer 必需

为“将选定仓库添加到组织机密”提供 HTTP 响应状态码

状态代码	描述
`204`	当仓库被添加到选定列表时，返回无内容
`404`	资源未找到
`409`	当可见性类型未设置为已选时发生冲突
`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 范围才能使用此端点。

用于“从组织密钥中删除选定存储库”的细粒度访问令牌

此端点适用于以下细粒度令牌类型

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

"组织 codespaces 机密" 组织权限（写入）和 "元数据" 仓库权限（读取）

“从组织密钥中删除选定存储库”的参数

标头
名称、类型、描述
`accept` string 建议设置为 `application/vnd.github+json`。

路径参数
名称、类型、描述
`org` string 必需组织名称。名称不区分大小写。
`secret_name` string 必需密钥的名称。
`repository_id` integer 必需

“从组织密钥中删除选定存储库”的 HTTP 响应状态代码

状态代码	描述
`204`	从选定列表中删除存储库时的响应
`404`	资源未找到
`409`	当可见性类型未设置为已选时发生冲突
`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

用于 Codespaces 组织秘密的 REST API 端点

请求示例

响应

请求示例

响应

请求示例

响应

请求示例

创建密钥时的响应

请求示例

响应

请求示例

响应

请求示例

响应

请求示例

当仓库被添加到选定列表时，返回无内容

请求示例

从选定列表中删除存储库时的响应