token_idintegerrequired
Delete a personal access token
Deletes a personal access token. Returns a 403 - Forbidden status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.
delete
http://HOSTNAME/api/v3/admin/tokens/{token_id}
Path Parameters
Response
204
Response
204
Response
delete/admin/tokens/{token_id}
Path Parameters
204
Create a user
If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also update the LDAP mapping for the user.
The login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send "octo_cat" as the login, a user named "octo-cat" will be created.
If the login name or email address is already associated with an account, the server will return a 422 response.
post
http://HOSTNAME/api/v3/admin/users
Body
application/json
Body
application/json
loginstringrequired
The user’s username.
emailstring
Required for built-in authentication. The user’s email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the GitHub authentication guide.
Response
201 application/json
Response
201 application/json
Response
Simple User
Simple User
namestring | null
emailstring | null
loginstringrequired
Example:octocat
idintegerrequired
Example:1
node_idstringrequired
Example:MDQ6VXNlcjE=
avatar_urlstring(uri)required
Example:https://github.com/images/error/octocat_happy.gif
gravatar_idstring | nullrequired
Example:41d064eb2195891e12d0413f63227ea7
urlstring(uri)required
Example:https://api.github.com/users/octocat
html_urlstring(uri)required
Example:https://github.com/octocat
followers_urlstring(uri)required
Example:https://api.github.com/users/octocat/followers
following_urlstringrequired
Example:https://api.github.com/users/octocat/following{/other_user}
gists_urlstringrequired
Example:https://api.github.com/users/octocat/gists{/gist_id}
starred_urlstringrequired
Example:https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_urlstring(uri)required
Example:https://api.github.com/users/octocat/subscriptions
organizations_urlstring(uri)required
Example:https://api.github.com/users/octocat/orgs
repos_urlstring(uri)required
Example:https://api.github.com/users/octocat/repos
events_urlstringrequired
Example:https://api.github.com/users/octocat/events{/privacy}
received_events_urlstring(uri)required
Example:https://api.github.com/users/octocat/received_events
typestringrequired
Example:User
site_adminbooleanrequired
starred_atstring
Example:"2020-07-09T00:17:55Z"
post/admin/users
Body
{
"login": "monalisa",
"email": "octocat@github.com"
}
201 application/json
Update the username for a user
patch
http://HOSTNAME/api/v3/admin/users/{username}
Path Parameters
usernamestringrequired
Body
application/json
Body
application/json
loginstringrequired
The user’s new username.
Response
202 application/json
Response
202 application/json
Response
messagestring
urlstring
patch/admin/users/{username}
Path Parameters
Body
{
"login": "thenewmonalisa"
}
202 application/json
Delete a user
Deleting a user will delete all their repositories, gists, applications, and personal settings. Suspending a user is often a better option.
You can delete any user account except your own.
delete
http://HOSTNAME/api/v3/admin/users/{username}
Path Parameters
usernamestringrequired
Response
204
Response
204
Response
delete/admin/users/{username}
Path Parameters
204
Create an impersonation OAuth token
post
http://HOSTNAME/api/v3/admin/users/{username}/authorizations
Path Parameters
usernamestringrequired
Body
application/json
Body
application/json
scopesarray[string]
A list of scopes.
Response
201 application/json
Response
201 application/json
Response
Authorization
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
idintegerrequired
urlstring(uri)required
scopesarray | null[string]required
A list of scopes that this authorization is in.
tokenstringrequired
token_last_eightstring | nullrequired
hashed_tokenstring | nullrequired
appobjectrequired
Show Child Parameters
notestring | nullrequired
note_urlstring | null(uri)required
updated_atstring(date-time)required
created_atstring(date-time)required
fingerprintstring | nullrequired
userobject | null
Simple User
Show Child Parameters
installationobject | null
Show Child Parameters
post/admin/users/{username}/authorizations
Path Parameters
Body
{}
201 application/json