users

List GPG keys for the authenticated user

Lists the current user's GPG keys.

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

get/user/gpg_keys

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/user/gpg_keys
  • Auth: none declared

Query parameters

per_pageinteger

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

pageinteger

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Response

Response

idinteger required
namestring nullable
primary_key_idinteger nullable required
key_idstring required
public_keystring required
can_signboolean required
can_encrypt_commsboolean required
can_encrypt_storageboolean required
can_certifyboolean required
created_atstring date-time required
expires_atstring date-time nullable required
revokedboolean required
raw_keystring nullable required

Example response

[
  {
    "id": 3,
    "name": "Octocat's GPG Key",
    "key_id": "3262EFF25BA0D270",
    "public_key": "xsBNBFayYZ...",
    "emails": [
      {
        "email": "octocat@users.noreply.github.com",
        "verified": true
      }
    ],
    "subkeys": [
      {
        "id": 4,
        "primary_key_id": 3,
        "key_id": "4A595D4C72EE49C7",
        "public_key": "zsBNBFayYZ...",
        "emails": [],
        "can_sign": false,
        "can_encrypt_comms": true,
        "can_encrypt_storage": true,
        "can_certify": false,
        "created_at": "2016-03-24T11:31:04-06:00",
        "expires_at": null,
        "revoked": false
      }
    ],
    "can_sign": true,
    "can_certify": true,
    "created_at": "2016-03-24T11:31:04-06:00",
    "revoked": true
  }
]

Changes

No recorded changes to this operation across all 83 revisions of this API.