List GPG keys for the authenticated user

GET

/user/gpg_keys

Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/user/gpg_keys'

Response Example

200 - Example 1

[
    {
        "can_certify": true,
        "can_encrypt_comms": true,
        "can_encrypt_storage": true,
        "can_sign": true,
        "created_at": "2016-03-24T17:31:04.000Z",
        "emails": [
            {
                "email": "octocat@users.noreply.github.com",
                "verified": true
            }
        ],
        "expires_at": "2019-08-24T14:15:22Z",
        "id": 3,
        "key_id": "3262EFF25BA0D270",
        "name": "Octocat's GPG Key",
        "primary_key_id": 0,
        "public_key": "xsBNBFayYZ...",
        "raw_key": "string",
        "revoked": true,
        "subkeys": [
            {
                "can_certify": false,
                "can_encrypt_comms": true,
                "can_encrypt_storage": true,
                "can_sign": false,
                "created_at": "2016-03-24T17:31:04.000Z",
                "emails": [],
                "expires_at": null,
                "id": 4,
                "key_id": "4A595D4C72EE49C7",
                "primary_key_id": 3,
                "public_key": "zsBNBFayYZ...",
                "revoked": false,
                "subkeys": []
            }
        ]
    }
]

Request

Query Params

per_page

integer

optional

The number of results per page (max 100).

page

integer

optional

Page number of the results to fetch.

Responses

🟢200Response

application/json

Body

array of:

can_certify

boolean

required

Example:

true

can_encrypt_comms

boolean

required

can_encrypt_storage

boolean

required

can_sign

boolean

required

Example:

true

created_at

string <date-time>

required

Example:

2016-03-24T17:31:04.000Z

emails

array [object {2}]

required

Example:

[{"email":"octocat@users.noreply.github.com","verified":true}]

string

optional

verified

boolean

optional

expires_at

string <date-time> | null

required

integer

required

Example:

key_id

string

required

Example:

3262EFF25BA0D270

name

string | null

optional

Example:

Octocat's GPG Key

primary_key_id

integer | null

required

public_key

string

required

Example:

xsBNBFayYZ...

raw_key

string | null

required

revoked

boolean

required

Example:

true

subkeys

array [object {14}]

required

Example:

[{"can_certify":false,"can_encrypt_comms":true,"can_encrypt_storage":true,"can_sign":false,"created_at":"2016-03-24T17:31:04.000Z","emails":[],"expires_at":null,"id":4,"key_id":"4A595D4C72EE49C7","primary_key_id":3,"public_key":"zsBNBFayYZ...","revoked":false,"subkeys":[]}]

can_certify

boolean

optional

can_encrypt_comms

boolean

optional

can_encrypt_storage

boolean

optional

can_sign

boolean

optional

created_at

string

optional

emails

array

optional

expires_at

string | null

optional

integer

optional

key_id

string

optional

primary_key_id

integer

optional

public_key

string

optional

raw_key

string | null

optional

revoked

boolean

optional

subkeys

array

optional

🔵304304

🟠401401

🟠403403

🟠404404

Modified at 2023-08-15 02:59:30

Follow a user

Create a GPG key for the authenticated user