usernamestringrequired
Demote a site administrator
You can demote any user account except your own.
delete
http://HOSTNAME/api/v3/users/{username}/site_admin
Path Parameters
Response
204
Response
204
Response
204
Suspend a user
If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.
You can suspend any user account except your own.
Note that, if you choose not to pass any parameters, you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
put
http://HOSTNAME/api/v3/users/{username}/suspended
Path Parameters
usernamestringrequired
Body
application/json
Body
application/json
reasonstring
The reason the user is being suspended. This message will be logged in the audit log. If you don’t provide a reason, it will default to “Suspended via API by SITE_ADMINISTRATOR”, where SITE_ADMINISTRATOR is the person who performed the action.
Response
204
Response
204
Response
204
Unsuspend a user
If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.
delete
http://HOSTNAME/api/v3/users/{username}/suspended
Path Parameters
usernamestringrequired
Body
application/json
Body
application/json
reasonstring
The reason the user is being unsuspended. This message will be logged in the audit log. If you don’t provide a reason, it will default to “Unsuspended via API by SITE_ADMINISTRATOR”, where SITE_ADMINISTRATOR is the person who performed the action.
Response
204
Response
204
Response
204
gists
View, modify your gists.
List gists for the authenticated user
Lists the authenticated user’s gists or if called anonymously, this endpoint returns all public gists:
get
http://HOSTNAME/api/v3/gists
Query Parameters
sincestring(date-time)
Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
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
Base Gist
urlstring(uri)required
forks_urlstring(uri)required
commits_urlstring(uri)required
idstringrequired
node_idstringrequired
git_pull_urlstring(uri)required
git_push_urlstring(uri)required
html_urlstring(uri)required
filesobjectrequired
publicbooleanrequired
created_atstring(date-time)required
updated_atstring(date-time)required
descriptionstring | nullrequired
commentsintegerrequired
userobject | nullrequired
Simple User
Show Child Parameters
comments_urlstring(uri)required
ownerobject
Simple User
Show Child Parameters
truncatedboolean
forksarray
historyarray
application/json