Git SSH 密钥_GitHub中文网

使用 REST API 管理经过身份验证的用户的 Git SSH 密钥。

关于 Git SSH 密钥管理

如果请求 URL 不含 {username} 参数，则响应将是登录用户的响应（必须随请求传递身份验证信息）。在通过作用域为 user 的 OAuth 进行身份验证时，将包含其他专用信息，例如用户是否启用双重身份验证。

List public SSH keys for the authenticated user

Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.

Parameters for "List public SSH keys for the authenticated user"

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

查询参数
名称, 类型, 说明
`per_page` integer The number of results per page (max 100). 默认: `30`
`page` integer Page number of the results to fetch. 默认: `1`

HTTP response status codes for "List public SSH keys for the authenticated user"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Code samples for "List public SSH keys for the authenticated user"

get/user/keys

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/user/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",
    "verified": false,
    "read_only": false
  },
  {
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
    "id": 3,
    "url": "https://api.github.com/user/keys/3",
    "title": "ssh-rsa AAAAB3NzaC1yc2EAAB",
    "created_at": "2020-07-11T21:31:57Z",
    "verified": false,
    "read_only": false
  }
]

Create a public SSH key for the authenticated user

Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:public_key scope.

Parameters for "Create a public SSH key for the authenticated user"

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

正文参数
名称, 类型, 说明
`title` string A descriptive name for the new key.
`key` string 必须 The public SSH key to add to your GitHub account.

HTTP response status codes for "Create a public SSH key for the authenticated user"

Status code	Description
`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 for "Create a public SSH key for the authenticated user"

post/user/keys

curl -L \
  -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/keys \
  -d '{"title":"ssh-rsa AAAAB3NzaC1yc2EAAA","key":"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234"}'

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",
  "verified": false,
  "read_only": false
}

Get a public SSH key for the authenticated user

View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:public_key scope.

Parameters for "Get a public SSH key for the authenticated user"

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`key_id` integer 必须 The unique identifier of the key.

HTTP response status codes for "Get a public SSH key for the authenticated user"

Status code	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Code samples for "Get a public SSH key for the authenticated user"

get/user/keys/{key_id}

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/user/keys/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",
  "verified": false,
  "read_only": false
}

Delete a public SSH key for the authenticated user

Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:public_key scope.

Parameters for "Delete a public SSH key for the authenticated user"

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`key_id` integer 必须 The unique identifier of the key.

HTTP response status codes for "Delete a public SSH key for the authenticated user"

Status code	Description
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Code samples for "Delete a public SSH key for the authenticated user"

delete/user/keys/{key_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/user/keys/KEY_ID

Response

Status: 204

List public keys for a user

Works with GitHub Apps

Lists the verified public SSH keys for a user. This is accessible by anyone.

Parameters for "List public keys for a user"

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`username` string 必须 The handle for the GitHub user account.

查询参数
名称, 类型, 说明
`per_page` integer The number of results per page (max 100). 默认: `30`
`page` integer Page number of the results to fetch. 默认: `1`

HTTP response status codes for "List public keys for a user"

Status code	Description
`200`	OK

Code samples for "List public keys for a user"

get/users/{username}/keys

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/keys

Response

Status: 200

[
  {
    "id": 1,
    "key": "ssh-rsa AAA..."
  }
]