Puntos de conexión de la API de REST para claves de firma SSH
La API de REST permite administrar claves de firma SSH de los usuarios autenticados.
Acerca de la administración de claves de firma SSH
Si una dirección URL de solicitud no incluye un parámetro {username}
, la respuesta será para el usuario que ha iniciado sesión (y debe pasar la información de autenticación con la solicitud). Información privada adicional, como si un usuario tiene habilitada la autenticación en dos fases, se incluye cuando se autentica a través de Autenticación básica o OAuth con el ámbito 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.
Tokens de acceso específicos para "List SSH signing keys for the authenticated user"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "SSH signing keys" user permissions (read)
Parámetros para "List SSH signing keys for the authenticated user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: |
Códigos de estado de respuesta HTTP para "List SSH signing keys for the authenticated user"
status code | Descripción |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "List SSH signing keys for the authenticated user"
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Create a SSH signing key for the authenticated user"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "SSH signing keys" user permissions (write)
Parámetros para "Create a SSH signing key for the authenticated user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
title string A descriptive name for the new key. |
key string RequeridoThe public SSH key to add to your GitHub account. For more information, see "Checking for existing SSH keys." |
Códigos de estado de respuesta HTTP para "Create a SSH signing key for the authenticated user"
status code | Descripción |
---|---|
201 | Created |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
422 | Validation failed, or the endpoint has been spammed. |
Ejemplos de código para "Create a SSH signing key for the authenticated user"
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Get an SSH signing key for the authenticated user"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "SSH signing keys" user permissions (read)
Parámetros para "Get an SSH signing key for the authenticated user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
ssh_signing_key_id integer RequeridoThe unique identifier of the SSH signing key. |
Códigos de estado de respuesta HTTP para "Get an SSH signing key for the authenticated user"
status code | Descripción |
---|---|
200 | OK |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "Get an SSH signing key for the authenticated user"
Ejemplo de solicitud
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.
Tokens de acceso específicos para "Delete an SSH signing key for the authenticated user"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
El token pormenorizado debe tener el siguiente conjunto de permisos:
- "SSH signing keys" user permissions (write)
Parámetros para "Delete an SSH signing key for the authenticated user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
ssh_signing_key_id integer RequeridoThe unique identifier of the SSH signing key. |
Códigos de estado de respuesta HTTP para "Delete an SSH signing key for the authenticated user"
status code | Descripción |
---|---|
204 | No Content |
304 | Not modified |
401 | Requires authentication |
403 | Forbidden |
404 | Resource not found |
Ejemplos de código para "Delete an SSH signing key for the authenticated user"
Ejemplo de solicitud
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.
Tokens de acceso específicos para "List SSH signing keys for a user"
Este punto de conexión funciona con los siguientes tipos de token pormenorizados:
- Tokens de acceso de usuario de la aplicación de GitHub
- Token de acceso a la instalación de la aplicación de GitHub
- Tokens de acceso personal específico
El token pormenorizado no requiere ningún permiso.
Este punto de conexión se puede usar sin autenticación si solo se solicitan recursos públicos.
Parámetros para "List SSH signing keys for a user"
Nombre, Tipo, Descripción |
---|
accept string Setting to |
Nombre, Tipo, Descripción |
---|
username string RequeridoThe handle for the GitHub user account. |
Nombre, Tipo, Descripción |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Valor predeterminado: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Valor predeterminado: |
Códigos de estado de respuesta HTTP para "List SSH signing keys for a user"
status code | Descripción |
---|---|
200 | OK |
Ejemplos de código para "List SSH signing keys for a user"
Ejemplo de solicitud
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"
}
]