Points de terminaison d’API REST pour les clés de signature SSH

À propos de l’administration des clés de signature SSH

Si une URL de requête n’inclut pas de paramètre {username}, la réponse est destinée à l’utilisateur connecté (et vous devez transmettre des informations d’authentification avec votre demande). Des informations privées supplémentaires, par exemple si l’authentification à 2 facteurs a été activée par un utilisateur, sont incluses lors de l’authentification au moyen de l’authentification de base ou OAuth avec l’étendue 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.

Paramètres pour « List SSH signing keys for the authenticated user »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de requête
Nom, Type, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1`

Codes d’état de la réponse HTTP pour « List SSH signing keys for the authenticated user »

Code d’état	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « List SSH signing keys for the authenticated user »

Exemple de requête

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.

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

Paramètres pour « Create a SSH signing key for the authenticated user »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres du corps
Nom, Type, Description
`title` string A descriptive name for the new key.
`key` string Obligatoire The public SSH key to add to your GitHub account. For more information, see "Checking for existing SSH keys."

Codes d’état de la réponse HTTP pour « Create a SSH signing key for the authenticated user »

Code d’état	Description
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Exemples de code pour « Create a SSH signing key for the authenticated user »

Exemple de requête

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.

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

Paramètres pour « Get an SSH signing key for the authenticated user »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`ssh_signing_key_id` integer Obligatoire The unique identifier of the SSH signing key.

Codes d’état de la réponse HTTP pour « Get an SSH signing key for the authenticated user »

Code d’état	Description
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « Get an SSH signing key for the authenticated user »

Exemple de requête

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.

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

Paramètres pour « Delete an SSH signing key for the authenticated user »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`ssh_signing_key_id` integer Obligatoire The unique identifier of the SSH signing key.

Codes d’état de la réponse HTTP pour « Delete an SSH signing key for the authenticated user »

Code d’état	Description
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Exemples de code pour « Delete an SSH signing key for the authenticated user »

Exemple de requête

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

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

Paramètres pour « List SSH signing keys for a user »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`username` string Obligatoire The handle for the GitHub user account.

Paramètres de requête
Nom, Type, Description
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: `1`

Codes d’état de la réponse HTTP pour « List SSH signing keys for a user »

Code d’état	Description
`200`	OK

Exemples de code pour « List SSH signing keys for a user »

Exemple de requête

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"
  }
]