Skip to main content

gpg_keys

Overview

Namegpg_keys
TypeResource
Idgithub.users.gpg_keys

Fields

NameDatatype
idinteger
namestring
public_keystring
can_certifyboolean
subkeysarray
revokedboolean
raw_keystring
key_idstring
primary_key_idinteger
can_encrypt_commsboolean
expires_atstring
can_signboolean
created_atstring
emailsarray
can_encrypt_storageboolean

Methods

NameAccessible byRequired ParamsDescription
get_gpg_key_for_authenticated_userSELECTgpg_key_idView extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.
list_gpg_keys_for_authenticated_userSELECTLists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least read:gpg_key scope.
list_gpg_keys_for_userSELECTusernameLists the GPG keys for a user. This information is accessible by anyone.
create_gpg_key_for_authenticated_userINSERTdata__armored_public_keyAdds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least write:gpg_key scope.
delete_gpg_key_for_authenticated_userDELETEgpg_key_idRemoves a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least admin:gpg_key scope.