SSH 签名密钥
使用 REST API 管理经过身份验证的用户的 SSH 签名密钥。
关于 SSH 签名密钥管理
如果请求 URL 不含 {username}
参数,则响应将是登录用户的响应(必须随请求传递身份验证信息)。 在通过基本身份验证或作用域为 user
的 OAuth 进行身份验证时,将包含其他专用信息,例如用户是否启用双因素身份验证。
List SSH signing keys for the authenticated user
Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least read:ssh_signing_key
scope. For more information, see "Understanding scopes for OAuth apps."
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Query parameters |
名称, Type, 说明 |
per_page integerThe number of results per page (max 100). Default: |
page integerPage number of the results to fetch. Default: |
HTTP response status codes
Status code | 说明 |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Code samples
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/user/ssh_signing_keys
Response
Status: 200
[
{
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
"id": 2,
"url": "https://api.github.com/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z"
},
{
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
"id": 3,
"url": "https://api.github.com/user/keys/3",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAB",
"created_at": "2020-07-11T21:31:57Z"
}
]
Create a SSH signing key for the authenticated user
Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least write:ssh_signing_key
scope. For more information, see "Understanding scopes for OAuth apps."
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Body parameters |
名称, Type, 说明 |
title stringA descriptive name for the new key. |
key stringRequiredThe public SSH key to add to your GitHub account. For more information, see "Checking for existing SSH keys." |
HTTP response status codes
Status code | 说明 |
---|---|
201 | Created |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Code samples
curl \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/user/ssh_signing_keys \
-d '{"key":"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234","title":"ssh-rsa AAAAB3NzaC1yc2EAAA"}'
Response
Status: 201
{
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
"id": 2,
"url": "https://api.github.com/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z"
}
Get an SSH signing key for the authenticated user
Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least read:ssh_signing_key
scope. For more information, see "Understanding scopes for OAuth apps."
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Path parameters |
名称, Type, 说明 |
ssh_signing_key_id integerRequiredThe unique identifier of the SSH signing key. |
HTTP response status codes
Status code | 说明 |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Code samples
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/user/ssh_signing_keys/SSH_SIGNING_KEY_ID
Response
Status: 200
{
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
"id": 2,
"url": "https://api.github.com/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z"
}
Delete an SSH signing key for the authenticated user
Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least admin:ssh_signing_key
scope. For more information, see "Understanding scopes for OAuth apps."
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Path parameters |
名称, Type, 说明 |
ssh_signing_key_id integerRequiredThe unique identifier of the SSH signing key. |
HTTP response status codes
Status code | 说明 |
---|---|
204 | No Content |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Code samples
curl \
-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/user/ssh_signing_keys/SSH_SIGNING_KEY_ID
Response
Status: 204
List SSH signing keys for a user
Lists the SSH signing keys for a user. This operation is accessible by anyone.
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Path parameters |
名称, Type, 说明 |
username stringRequiredThe handle for the GitHub user account. |
Query parameters |
名称, Type, 说明 |
per_page integerThe number of results per page (max 100). Default: |
page integerPage number of the results to fetch. Default: |
HTTP response status codes
Status code | 说明 |
---|---|
200 | OK |
Code samples
curl \
-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/ssh_signing_keys
Response
Status: 200
[
{
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
"id": 2,
"url": "https://api.github.com/user/keys/2",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
"created_at": "2020-06-11T21:31:57Z"
},
{
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
"id": 3,
"url": "https://api.github.com/user/keys/3",
"title": "ssh-rsa AAAAB3NzaC1yc2EAAB",
"created_at": "2020-07-11T21:31:57Z"
}
]