usernamestringrequired
Check if a person is followed by the authenticated user
get
{protocol}://{hostname}/api/v3/user/following/{username}
Path Parameters
Response
Response
if the person is followed by the authenticated user
get/user/following/{username}
Path Parameters
Follow a user
Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
put
{protocol}://{hostname}/api/v3/user/following/{username}
Path Parameters
usernamestringrequired
Response
Response
Response
put/user/following/{username}
Path Parameters
Unfollow a user
Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the user:follow scope.
delete
{protocol}://{hostname}/api/v3/user/following/{username}
Path Parameters
usernamestringrequired
Response
Response
Response
delete/user/following/{username}
Path Parameters
List GPG keys for the authenticated user
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.
get
{protocol}://{hostname}/api/v3/user/gpg_keys
Query Parameters
per_pageinteger
Results per page (max 100)
Default:30
pageinteger
Page number of the results to fetch.
Default:1
Response
application/json
Response
application/json
Response
A unique encryption key
idintegerrequired
Example:3
primary_key_idinteger | nullrequired
key_idstringrequired
Example:3262EFF25BA0D270
public_keystringrequired
Example:xsBNBFayYZ...
emailsarray[object]required
Example:[{"email":"mastahyeti@users.noreply.github.com","verified":true}]
Show Child Parameters
subkeysarray[object]required
Example:[{"id":4,"primary_key_id":3,"key_id":"4A595D4C72EE49C7","public_key":"zsBNBFayYZ...","emails":[],"subkeys":[],"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}]
Show Child Parameters
can_signbooleanrequired
Example:true
can_encrypt_commsbooleanrequired
can_encrypt_storagebooleanrequired
can_certifybooleanrequired
Example:true
created_atstring(date-time)required
Example:2016-03-24T11:31:04-06:00
expires_atstring | null(date-time)required
raw_keystring | nullrequired
get/user/gpg_keys
Query Parameters
application/json
Create a GPG key for the authenticated user
Adds 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.
post
{protocol}://{hostname}/api/v3/user/gpg_keys
Body
application/json
Body
application/json
armored_public_keystringrequired
A GPG key in ASCII-armored format.
Response
application/json
Response
application/json
Response
GPG Key
A unique encryption key
idintegerrequired
Example:3
primary_key_idinteger | nullrequired
key_idstringrequired
Example:3262EFF25BA0D270
public_keystringrequired
Example:xsBNBFayYZ...
emailsarray[object]required
Example:[{"email":"mastahyeti@users.noreply.github.com","verified":true}]
Show Child Parameters
subkeysarray[object]required
Example:[{"id":4,"primary_key_id":3,"key_id":"4A595D4C72EE49C7","public_key":"zsBNBFayYZ...","emails":[],"subkeys":[],"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}]
Show Child Parameters
can_signbooleanrequired
Example:true
can_encrypt_commsbooleanrequired
can_encrypt_storagebooleanrequired
can_certifybooleanrequired
Example:true
created_atstring(date-time)required
Example:2016-03-24T11:31:04-06:00
expires_atstring | null(date-time)required
raw_keystring | nullrequired
post/user/gpg_keys
Body
{
"armored_public_key": "armored_public_key"
}
application/json