REST API 现在已版本化。 有关更多信息,请参阅“关于 API 版本控制”。
工件证明的 REST API 端点
使用 REST API 管理工件证明。
列出证明
列出与用户拥有的代码仓库关联的、具有给定主题摘要的一组工件证明。
此端点返回的证明集合根据经过身份验证的用户权限进行过滤;如果经过身份验证的用户无法读取代码仓库,则与该代码仓库关联的证明将不包含在响应中。此外,当使用细粒度访问令牌时,需要 attestations:read
权限。
请注意:为了提供有意义的安全优势,证明的签名和时间戳**必须**进行密码验证,并且**必须**验证证明签署者的身份。可以使用 GitHub CLI 的 attestation verify
命令 验证证明。有关更多信息,请参阅 我们关于如何使用工件证明来建立构建来源的指南。
“列出证明”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌不需要任何权限。
如果仅请求公共资源,则无需身份验证即可使用此端点。
“列出证明”的参数
名称,类型,描述 |
---|
accept 字符串建议设置为 |
名称,类型,描述 |
---|
username 字符串 必需GitHub 用户帐户的句柄。 |
subject_digest 字符串 必需主题摘要 |
名称,类型,描述 |
---|
per_page 整数每页结果数(最大 100)。有关更多信息,请参阅“在 REST API 中使用分页”。 默认值: |
before 字符串游标,如 链接标头 中所示。如果指定,则查询仅搜索此游标之前的结果。有关更多信息,请参阅“在 REST API 中使用分页”。 |
after 字符串游标,如 链接标头 中所示。如果指定,则查询仅搜索此游标之后的结果。有关更多信息,请参阅“在 REST API 中使用分页”。 |
“列出证明”的 HTTP 响应状态代码
状态代码 | 描述 |
---|---|
200 | 确定 |
201 | 已创建 |
204 | 无内容 |
404 | 资源未找到 |
“列出证明”的代码示例
请求示例
get/users/{username}/attestations/{subject_digest}
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/users/USERNAME/attestations/SUBJECT_DIGEST
响应