Конечные точки REST API для ключей подписывания SSH

Сведения об администрировании ключа подписывания SSH

Если URL-адрес запроса не содержит {username} параметр, ответ будет использоваться для пользователя, вошедшего в систему (и необходимо передать сведения о проверке подлинности с запросом). Дополнительные частные сведения, такие как включение двухфакторной проверки подлинности, включаются при проверке подлинности через Обычная проверка подлинности или OAuth с областью user .

List SSH signing keys for the authenticated user

Lists the SSH signing keys for the authenticated user's GitHub account.

OAuth app tokens and personal access tokens (classic) need the read:ssh_signing_key scope to use this endpoint.

Подробные маркеры доступа для "List SSH signing keys for the authenticated user

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"SSH signing keys" user permissions (read)

Параметры для "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). For more information, see "Using pagination in the REST API." По умолчанию.: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: `1`

Коды состояния http-ответа для "List SSH signing keys for the authenticated user"

Код состояния	Описание
`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>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

OAuth app tokens and personal access tokens (classic) need the write:ssh_signing_key scope to use this endpoint.

Подробные маркеры доступа для "Create a SSH signing key for the authenticated user

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"SSH signing keys" user permissions (write)

Параметры для "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."

Коды состояния http-ответа для "Create a SSH signing key for the authenticated user"

Код состояния	Описание
`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>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

OAuth app tokens and personal access tokens (classic) need the read:ssh_signing_key scope to use this endpoint.

Подробные маркеры доступа для "Get an SSH signing key for the authenticated user

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"SSH signing keys" user permissions (read)

Параметры для "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.

Коды состояния http-ответа для "Get an SSH signing key for the authenticated user"

Код состояния	Описание
`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>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

OAuth app tokens and personal access tokens (classic) need the admin:ssh_signing_key scope to use this endpoint.

Подробные маркеры доступа для "Delete an SSH signing key for the authenticated user

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"SSH signing keys" user permissions (write)

Параметры для "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.

Коды состояния http-ответа для "Delete an SSH signing key for the authenticated user"

Код состояния	Описание
`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>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/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.

Подробные маркеры доступа для "List SSH signing keys for a user

Эта конечная точка работает со следующими точными типами маркеров:

Для тонкого маркера не требуются разрешения.

Эту конечную точку можно использовать без проверки подлинности, если запрашиваются только общедоступные ресурсы.

Параметры для "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). For more information, see "Using pagination in the REST API." По умолчанию.: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." По умолчанию.: `1`

Коды состояния http-ответа для "List SSH signing keys for a user"

Код состояния	Описание
`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>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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"
  }
]