SSH-Signaturschlüssel

Verwende die REST-API, um die SSH-Signaturschlüssel authentifizierter Benutzer*innen zu verwalten.

Informationen zur Verwaltung von SSH-Signaturschlüsseln

Wenn eine Anforderungs-URL keinen {username}-Parameter enthält, ist die Antwort für die angemeldete Benutzerin bzw. den angemeldeten Benutzer bestimmt (Übergeben von Authentifizierungsinformationen mit der Anforderung erforderlich). Zusätzliche private Informationen (z. B. ob die Zwei-Faktor-Authentifizierung für einen Benutzerin aktiviert ist) sind enthalten, wenn die Authentifizierung über OAuth mit dem user-Bereich erfolgt.

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

Parameter für „List SSH signing keys for the authenticated user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 100). Standard: `30`
`page` integer Page number of the results to fetch. Standard: `1`

HTTP-Antwortstatuscodes für „List SSH signing keys for the authenticated user“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Codebeispiele für „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" \
  https://api.github.com/user/ssh_signing_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"
  },
  {
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
    "id": 3,
    "url": "https://api.github.com/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."

Parameter für „Create a SSH signing key for the authenticated user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Textparameter
Name, type, BESCHREIBUNG
`title` string A descriptive name for the new key.
`key` string Erforderlich The public SSH key to add to your GitHub account. For more information, see "Checking for existing SSH keys."

HTTP-Antwortstatuscodes für „Create a SSH signing key for the authenticated user“

Statuscode	BESCHREIBUNG
`201`	Created
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „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" \
  https://api.github.com/user/ssh_signing_keys \
  -d '{"key":"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234","title":"ssh-rsa AAAAB3NzaC1yc2EAAA"}'

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

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

Parameter für „Get an SSH signing key for the authenticated user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`ssh_signing_key_id` integer Erforderlich The unique identifier of the SSH signing key.

HTTP-Antwortstatuscodes für „Get an SSH signing key for the authenticated user“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Codebeispiele für „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" \
  https://api.github.com/user/ssh_signing_keys/SSH_SIGNING_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"
}

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

Parameter für „Delete an SSH signing key for the authenticated user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`ssh_signing_key_id` integer Erforderlich The unique identifier of the SSH signing key.

HTTP-Antwortstatuscodes für „Delete an SSH signing key for the authenticated user“

Statuscode	BESCHREIBUNG
`204`	No Content
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found

Codebeispiele für „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" \
  https://api.github.com/user/ssh_signing_keys/SSH_SIGNING_KEY_ID

Response

Status: 204

List SSH signing keys for a user

Funktioniert mit GitHub Apps

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

Parameter für „List SSH signing keys for a user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`username` string Erforderlich The handle for the GitHub user account.

Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 100). Standard: `30`
`page` integer Page number of the results to fetch. Standard: `1`

HTTP-Antwortstatuscodes für „List SSH signing keys for a user“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „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" \
  https://api.github.com/users/USERNAME/ssh_signing_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"
  },
  {
    "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
    "id": 3,
    "url": "https://api.github.com/user/keys/3",
    "title": "ssh-rsa AAAAB3NzaC1yc2EAAB",
    "created_at": "2020-07-11T21:31:57Z"
  }
]