SSH 서명 키

REST API를 사용하여 인증된 사용자의 SSH 서명 키를 관리합니다.

SSH 서명 키 관리 정보

요청 URL에 매개 변수가 {username} 포함되어 있지 않으면 로그인한 사용자에 대한 응답이 됩니다.{ % ifversion fpt or ghes or ghec %} 사용자가 2단계 인증을 사용할 수 있는지 여부와 같은 추가 개인 정보는 기본 인증 또는 OAuth user 를 통해 인증될 때 범위에 포함됩니다.{ % endif %}

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."

"List SSH signing keys for the authenticated user"에 대한 매개 변수

헤더
이름, 형식, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
쿼리 매개 변수
이름, 형식, Description
`per_page` integer The number of results per page (max 100). 기본값: `30`
`page` integer Page number of the results to fetch. 기본값: `1`

"List SSH signing keys for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

"List SSH signing keys for the authenticated user"에 대한 코드 샘플

get/user/ssh_signing_keys

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/user/ssh_signing_keys

Response

Status: 200

[
  {
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
    "id": 2,
    "url": "https://HOSTNAME/user/keys/2",
    "title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
    "created_at": "2020-06-11T21:31:57Z"
  },
  {
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
    "id": 3,
    "url": "https://HOSTNAME/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."

"Create a SSH signing key for the authenticated user"에 대한 매개 변수

헤더
이름, 형식, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
본문 매개 변수
이름, 형식, Description
`title` string A descriptive name for the new key.
`key` string 필수 The public SSH key to add to your GitHub account. For more information, see "Checking for existing SSH keys."

"Create a SSH signing key for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

"Create a SSH signing key for the authenticated user"에 대한 코드 샘플

post/user/ssh_signing_keys

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/user/ssh_signing_keys \
  -d '{"key":"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234","title":"ssh-rsa AAAAB3NzaC1yc2EAAA"}'

Response

Status: 201

{
  "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
  "id": 2,
  "url": "https://HOSTNAME/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."

"Get an SSH signing key for the authenticated user"에 대한 매개 변수

헤더
이름, 형식, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
이름, 형식, Description
`ssh_signing_key_id` integer 필수 The unique identifier of the SSH signing key.

"Get an SSH signing key for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

"Get an SSH signing key for the authenticated user"에 대한 코드 샘플

get/user/ssh_signing_keys/{ssh_signing_key_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/user/ssh_signing_keys/SSH_SIGNING_KEY_ID

Response

Status: 200

{
  "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
  "id": 2,
  "url": "https://HOSTNAME/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."

"Delete an SSH signing key for the authenticated user"에 대한 매개 변수

헤더
이름, 형식, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
이름, 형식, Description
`ssh_signing_key_id` integer 필수 The unique identifier of the SSH signing key.

"Delete an SSH signing key for the authenticated user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

"Delete an SSH signing key for the authenticated user"에 대한 코드 샘플

delete/user/ssh_signing_keys/{ssh_signing_key_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/user/ssh_signing_keys/SSH_SIGNING_KEY_ID

Response

Status: 204

List SSH signing keys for a user

에서 작동 GitHub Apps

Lists the SSH signing keys for a user. This operation is accessible by anyone.

"List SSH signing keys for a user"에 대한 매개 변수

헤더
이름, 형식, Description
`accept` string Setting to `application/vnd.github+json` is recommended.
경로 매개 변수
이름, 형식, Description
`username` string 필수 The handle for the GitHub user account.
쿼리 매개 변수
이름, 형식, Description
`per_page` integer The number of results per page (max 100). 기본값: `30`
`page` integer Page number of the results to fetch. 기본값: `1`

"List SSH signing keys for a user"에 대한 HTTP 응답 상태 코드

상태 코드	Description
`200`	OK

"List SSH signing keys for a user"에 대한 코드 샘플

get/users/{username}/ssh_signing_keys

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  http(s)://HOSTNAME/api/v3/users/USERNAME/ssh_signing_keys

Response

Status: 200

[
  {
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
    "id": 2,
    "url": "https://HOSTNAME/user/keys/2",
    "title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
    "created_at": "2020-06-11T21:31:57Z"
  },
  {
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
    "id": 3,
    "url": "https://HOSTNAME/user/keys/3",
    "title": "ssh-rsa AAAAB3NzaC1yc2EAAB",
    "created_at": "2020-07-11T21:31:57Z"
  }
]