GitHub API
  1. enterprise-admin
GitHub API
  • meta
    • GitHub API Root
    • Get GitHub Enterprise Server meta information
    • Get Octocat
    • Get the Zen of GitHub
  • enterprise-admin
    • List global webhooks
      GET
    • Create a global webhook
      POST
    • Delete a global webhook
      DELETE
    • Get a global webhook
      GET
    • Update a global webhook
      PATCH
    • Ping a global webhook
      POST
    • List public keys
      GET
    • Delete a public key
      DELETE
    • Update LDAP mapping for a team
      PATCH
    • Sync LDAP mapping for a team
      POST
    • Update LDAP mapping for a user
      PATCH
    • Sync LDAP mapping for a user
      POST
    • Create an organization
      POST
    • Update an organization name
      PATCH
    • List pre-receive environments
      GET
    • Create a pre-receive environment
      POST
    • Delete a pre-receive environment
      DELETE
    • Get a pre-receive environment
      GET
    • Update a pre-receive environment
      PATCH
    • Start a pre-receive environment download
      POST
    • Get the download status for a pre-receive environment
      GET
    • List pre-receive hooks
      GET
    • Create a pre-receive hook
      POST
    • Delete a pre-receive hook
      DELETE
    • Get a pre-receive hook
      GET
    • Update a pre-receive hook
      PATCH
    • List personal access tokens
      GET
    • Delete a personal access token
      DELETE
    • Create a user
      POST
    • Delete a user
      DELETE
    • Update the username for a user
      PATCH
    • Delete an impersonation OAuth token
      DELETE
    • Create an impersonation OAuth token
      POST
    • Get license information
      GET
    • Get statistics
      GET
    • List self-hosted runner groups for an enterprise
      GET
    • Create a self-hosted runner group for an enterprise
      POST
    • Delete a self-hosted runner group from an enterprise
      DELETE
    • Get a self-hosted runner group for an enterprise
      GET
    • Update a self-hosted runner group for an enterprise
      PATCH
    • List organization access to a self-hosted runner group in an enterprise
      GET
    • Set organization access for a self-hosted runner group in an enterprise
      PUT
    • Remove organization access to a self-hosted runner group in an enterprise
      DELETE
    • Add organization access to a self-hosted runner group in an enterprise
      PUT
    • List self-hosted runners in a group for an enterprise
      GET
    • Set self-hosted runners in a group for an enterprise
      PUT
    • Remove a self-hosted runner from a group for an enterprise
      DELETE
    • Add a self-hosted runner to a group for an enterprise
      PUT
    • List self-hosted runners for an enterprise
      GET
    • List runner applications for an enterprise
      GET
    • Create a registration token for an enterprise
      POST
    • Create a remove token for an enterprise
      POST
    • Delete a self-hosted runner from an enterprise
      DELETE
    • Get a self-hosted runner for an enterprise
      GET
    • List pre-receive hooks for an organization
      GET
    • Remove pre-receive hook enforcement for an organization
      DELETE
    • Get a pre-receive hook for an organization
      GET
    • Update pre-receive hook enforcement for an organization
      PATCH
    • List pre-receive hooks for a repository
      GET
    • Remove pre-receive hook enforcement for a repository
      DELETE
    • Get a pre-receive hook for a repository
      GET
    • Update pre-receive hook enforcement for a repository
      PATCH
    • Get the configuration status
      GET
    • Start a configuration process
      POST
    • Get the maintenance status
      GET
    • Enable or disable maintenance mode
      POST
    • Get settings
      GET
    • Set settings
      PUT
    • Remove an authorized SSH key
      DELETE
    • Get all authorized SSH keys
      GET
    • Add an authorized SSH key
      POST
    • Create a GitHub license
      POST
    • Upgrade a license
      POST
    • Demote a site administrator
      DELETE
    • Promote a user to be a site administrator
      PUT
    • Unsuspend a user
      DELETE
    • Suspend a user
      PUT
  • apps
    • Get the authenticated app
    • Create a GitHub App from a manifest
    • List installations for the authenticated app
    • Delete an installation for the authenticated app
    • Get an installation for the authenticated app
    • Create an installation access token for an app
    • Unsuspend an app installation
    • Suspend an app installation
    • Delete an app authorization
    • Revoke a grant for an application
    • Delete an app token
    • Reset a token
    • Check a token
    • Revoke an authorization for an application
    • Check an authorization
    • Reset an authorization
    • Get an app
    • List repositories accessible to the app installation
    • Revoke an installation access token
    • Get an organization installation for the authenticated app
    • Create a content attachment
    • Get a repository installation for the authenticated app
    • List app installations accessible to the user access token
    • List repositories accessible to the user access token
    • Remove a repository from an app installation
    • Add a repository to an app installation
    • Get a user installation for the authenticated app
  • oauth-authorizations
    • List your grants
    • Delete a grant
    • Get a single grant
    • List your authorizations
    • Create a new authorization
    • Get-or-create an authorization for a specific app
    • Get-or-create an authorization for a specific app and fingerprint
    • Delete an authorization
    • Get a single authorization
    • Update an existing authorization
  • codes-of-conduct
    • Get all codes of conduct
    • Get a code of conduct
  • emojis
    • Get emojis
  • activity
    • List public events
    • Get feeds
    • List public events for a network of repositories
    • List notifications for the authenticated user
    • Mark notifications as read
    • Get a thread
    • Mark a thread as read
    • Delete a thread subscription
    • Get a thread subscription for the authenticated user
    • Set a thread subscription
    • List public organization events
    • List repository events
    • List repository notifications for the authenticated user
    • Mark repository notifications as read
    • List stargazers
    • List watchers
    • Delete a repository subscription
    • Get a repository subscription
    • Set a repository subscription
    • List repositories starred by the authenticated user
    • Unstar a repository for the authenticated user
    • Check if a repository is starred by the authenticated user
    • Star a repository for the authenticated user
    • List repositories watched by the authenticated user
    • List events for the authenticated user
    • List organization events for the authenticated user
    • List public events for a user
    • List events received by the authenticated user
    • List public events received by a user
    • List repositories starred by a user
    • List repositories watched by a user
  • gists
    • List gists for the authenticated user
    • Create a gist
    • List public gists
    • List starred gists
    • Delete a gist
    • Get a gist
    • Update a gist
    • List gist comments
    • Create a gist comment
    • Delete a gist comment
    • Get a gist comment
    • Update a gist comment
    • List gist commits
    • List gist forks
    • Fork a gist
    • Unstar a gist
    • Check if a gist is starred
    • Star a gist
    • Get a gist revision
    • List gists for a user
  • gitignore
    • Get all gitignore templates
    • Get a gitignore template
  • issues
    • List issues assigned to the authenticated user
    • List organization issues assigned to the authenticated user
    • List assignees
    • Check if a user can be assigned
    • List repository issues
    • Create an issue
    • List issue comments for a repository
    • Delete an issue comment
    • Get an issue comment
    • Update an issue comment
    • List issue events for a repository
    • Get an issue event
    • Get an issue
    • Update an issue
    • Remove assignees from an issue
    • Add assignees to an issue
    • List issue comments
    • Create an issue comment
    • List issue events
    • Remove all labels from an issue
    • List labels for an issue
    • Add labels to an issue
    • Set labels for an issue
    • Remove a label from an issue
    • Unlock an issue
    • Lock an issue
    • List timeline events for an issue
    • List labels for a repository
    • Create a label
    • Delete a label
    • Get a label
    • Update a label
    • List milestones
    • Create a milestone
    • Delete a milestone
    • Get a milestone
    • Update a milestone
    • List labels for issues in a milestone
    • List user account issues assigned to the authenticated user
  • licenses
    • Get all commonly used licenses
    • Get a license
    • Get the license for a repository
  • markdown
    • Render a Markdown document
    • Render a Markdown document in raw mode
  • orgs
    • List organizations
    • Get an organization
    • Update an organization
    • List organization webhooks
    • Create an organization webhook
    • Delete an organization webhook
    • Get an organization webhook
    • Update an organization webhook
    • Ping an organization webhook
    • List app installations for an organization
    • List organization members
    • Remove an organization member
    • Check organization membership for a user
    • Remove organization membership for a user
    • Get organization membership for a user
    • Set organization membership for a user
    • List outside collaborators for an organization
    • Remove outside collaborator from an organization
    • Convert an organization member to outside collaborator
    • List public organization members
    • Remove public organization membership for the authenticated user
    • Check public organization membership for a user
    • Set public organization membership for the authenticated user
    • List organization memberships for the authenticated user
    • Get an organization membership for the authenticated user
    • Update an organization membership for the authenticated user
    • List organizations for the authenticated user
    • List organizations for a user
  • actions
    • List self-hosted runner groups for an organization
    • Create a self-hosted runner group for an organization
    • Delete a self-hosted runner group from an organization
    • Get a self-hosted runner group for an organization
    • Update a self-hosted runner group for an organization
    • List repository access to a self-hosted runner group in an organization
    • Set repository access for a self-hosted runner group in an organization
    • Remove repository access to a self-hosted runner group in an organization
    • Add repository access to a self-hosted runner group in an organization
    • List self-hosted runners in a group for an organization
    • Set self-hosted runners in a group for an organization
    • Remove a self-hosted runner from a group for an organization
    • Add a self-hosted runner to a group for an organization
    • List self-hosted runners for an organization
    • List runner applications for an organization
    • Create a registration token for an organization
    • Create a remove token for an organization
    • Delete a self-hosted runner from an organization
    • Get a self-hosted runner for an organization
    • List organization secrets
    • Get an organization public key
    • Delete an organization secret
    • Get an organization secret
    • Create or update an organization secret
    • List selected repositories for an organization secret
    • Set selected repositories for an organization secret
    • Remove selected repository from an organization secret
    • Add selected repository to an organization secret
    • List artifacts for a repository
    • Delete an artifact
    • Get an artifact
    • Download an artifact
    • Get a job for a workflow run
    • Download job logs for a workflow run
    • List self-hosted runners for a repository
    • List runner applications for a repository
    • Create a registration token for a repository
    • Create a remove token for a repository
    • Delete a self-hosted runner from a repository
    • Get a self-hosted runner for a repository
    • List workflow runs for a repository
    • Delete a workflow run
    • Get a workflow run
    • List workflow run artifacts
    • Cancel a workflow run
    • List jobs for a workflow run
    • Delete workflow run logs
    • Download workflow run logs
    • Re-run a workflow
    • List repository secrets
    • Get a repository public key
    • Delete a repository secret
    • Get a repository secret
    • Create or update a repository secret
    • List repository workflows
    • Get a workflow
    • Create a workflow dispatch event
    • List workflow runs
  • projects
    • List organization projects
    • Create an organization project
    • Delete a project card
    • Get a project card
    • Update an existing project card
    • Move a project card
    • Delete a project column
    • Get a project column
    • Update an existing project column
    • List project cards
    • Create a project card
    • Move a project column
    • Delete a project
    • Get a project
    • Update a project
    • List project collaborators
    • Remove user as a collaborator
    • Add project collaborator
    • Get project permission for a user
    • List project columns
    • Create a project column
    • List repository projects
    • Create a repository project
    • Create a user project
    • List user projects
  • repos
    • List organization repositories
    • Create an organization repository
    • Delete a repository
    • Get a repository
    • Update a repository
    • List branches
    • Get a branch
    • Delete branch protection
    • Get branch protection
    • Update branch protection
    • Delete admin branch protection
    • Get admin branch protection
    • Set admin branch protection
    • Delete pull request review protection
    • Get pull request review protection
    • Update pull request review protection
    • Delete commit signature protection
    • Get commit signature protection
    • Create commit signature protection
    • Remove status check protection
    • Get status checks protection
    • Update status check protection
    • Remove status check contexts
    • Get all status check contexts
    • Add status check contexts
    • Set status check contexts
    • Delete access restrictions
    • Get access restrictions
    • Remove app access restrictions
    • Get apps with access to the protected branch
    • Add app access restrictions
    • Set app access restrictions
    • Remove team access restrictions
    • Get teams with access to the protected branch
    • Add team access restrictions
    • Set team access restrictions
    • Remove user access restrictions
    • Get users with access to the protected branch
    • Add user access restrictions
    • Set user access restrictions
    • List repository collaborators
    • Remove a repository collaborator
    • Check if a user is a repository collaborator
    • Add a repository collaborator
    • Get repository permissions for a user
    • List commit comments for a repository
    • Delete a commit comment
    • Get a commit comment
    • Update a commit comment
    • List commits
    • List branches for HEAD commit
    • List commit comments
    • Create a commit comment
    • List pull requests associated with a commit
    • Get a commit
    • Get the combined status for a specific reference
    • List commit statuses for a reference
    • Compare two commits
    • Delete a file
    • Get repository content
    • Create or update file contents
    • List repository contributors
    • List deployments
    • Create a deployment
    • Delete a deployment
    • Get a deployment
    • List deployment statuses
    • Create a deployment status
    • Get a deployment status
    • Create a repository dispatch event
    • List forks
    • Create a fork
    • List repository webhooks
    • Create a repository webhook
    • Delete a repository webhook
    • Get a repository webhook
    • Update a repository webhook
    • Ping a repository webhook
    • Test the push repository webhook
    • List repository invitations
    • Delete a repository invitation
    • Update a repository invitation
    • List deploy keys
    • Create a deploy key
    • Delete a deploy key
    • Get a deploy key
    • List repository languages
    • Merge a branch
    • Delete a GitHub Enterprise Server Pages site
    • Get a GitHub Enterprise Server Pages site
    • Create a GitHub Enterprise Server Pages site
    • Update information about a GitHub Enterprise Server Pages site
    • List GitHub Enterprise Server Pages builds
    • Request a GitHub Enterprise Server Pages build
    • Get latest Pages build
    • Get GitHub Enterprise Server Pages build
    • Get a repository README
    • Get a repository README for a directory
    • List releases
    • Create a release
    • Delete a release asset
    • Get a release asset
    • Update a release asset
    • Get the latest release
    • Get a release by tag name
    • Delete a release
    • Get a release
    • Update a release
    • List release assets
    • Upload a release asset
    • Get the weekly commit activity
    • Get the last year of commit activity
    • Get all contributor commit activity
    • Get the weekly commit count
    • Get the hourly commit count for each day
    • Create a commit status
    • List repository tags
    • Download a repository archive (tar)
    • List repository teams
    • Get all repository topics
    • Replace all repository topics
    • Transfer a repository
    • Download a repository archive (zip)
    • Create a repository using a template
    • List public repositories
    • List repositories for the authenticated user
    • Create a repository for the authenticated user
    • List repository invitations for the authenticated user
    • Decline a repository invitation
    • Accept a repository invitation
    • List repositories for a user
  • teams
    • List teams
    • Create a team
    • Delete a team
    • Get a team by name
    • Update a team
    • List discussions
    • Create a discussion
    • Delete a discussion
    • Get a discussion
    • Update a discussion
    • List discussion comments
    • Create a discussion comment
    • Delete a discussion comment
    • Get a discussion comment
    • Update a discussion comment
    • List team members
    • Remove team membership for a user
    • Get team membership for a user
    • Add or update team membership for a user
    • List team projects
    • Remove a project from a team
    • Check team permissions for a project
    • Add or update team project permissions
    • List team repositories
    • Remove a repository from a team
    • Check team permissions for a repository
    • Add or update team repository permissions
    • List child teams
    • Delete a team (Legacy)
    • Get a team (Legacy)
    • Update a team (Legacy)
    • List discussions (Legacy)
    • Create a discussion (Legacy)
    • Delete a discussion (Legacy)
    • Get a discussion (Legacy)
    • Update a discussion (Legacy)
    • List discussion comments (Legacy)
    • Create a discussion comment (Legacy)
    • Delete a discussion comment (Legacy)
    • Get a discussion comment (Legacy)
    • Update a discussion comment (Legacy)
    • List team members (Legacy)
    • Remove team member (Legacy)
    • Get team member (Legacy)
    • Add team member (Legacy)
    • Remove team membership for a user (Legacy)
    • Get team membership for a user (Legacy)
    • Add or update team membership for a user (Legacy)
    • List team projects (Legacy)
    • Remove a project from a team (Legacy)
    • Check team permissions for a project (Legacy)
    • Add or update team project permissions (Legacy)
    • List team repositories (Legacy)
    • Remove a repository from a team (Legacy)
    • Check team permissions for a repository (Legacy)
    • Add or update team repository permissions (Legacy)
    • List child teams (Legacy)
    • List teams for the authenticated user
  • reactions
    • List reactions for a team discussion comment
    • Create reaction for a team discussion comment
    • Delete team discussion comment reaction
    • List reactions for a team discussion
    • Create reaction for a team discussion
    • Delete team discussion reaction
    • Delete a reaction (Legacy)
    • List reactions for a commit comment
    • Create reaction for a commit comment
    • Delete a commit comment reaction
    • List reactions for an issue comment
    • Create reaction for an issue comment
    • Delete an issue comment reaction
    • List reactions for an issue
    • Create reaction for an issue
    • Delete an issue reaction
    • List reactions for a pull request review comment
    • Create reaction for a pull request review comment
    • Delete a pull request comment reaction
    • List reactions for a team discussion comment (Legacy)
    • Create reaction for a team discussion comment (Legacy)
    • List reactions for a team discussion (Legacy)
    • Create reaction for a team discussion (Legacy)
  • rate-limit
    • Get rate limit status for the authenticated user
  • checks
    • Create a check run
    • Get a check run
    • Update a check run
    • List check run annotations
    • Create a check suite
    • Update repository preferences for check suites
    • Get a check suite
    • List check runs in a check suite
    • Rerequest a check suite
    • List check runs for a Git reference
    • List check suites for a Git reference
  • code-scanning
    • List code scanning alerts for a repository
    • Get a code scanning alert
    • Update a code scanning alert
    • List code scanning analyses for a repository
    • Upload an analysis as SARIF data
  • git
    • Create a blob
    • Get a blob
    • Create a commit
    • Get a commit
    • List matching references
    • Get a reference
    • Create a reference
    • Delete a reference
    • Update a reference
    • Create a tag object
    • Get a tag
    • Create a tree
    • Get a tree
  • pulls
    • List pull requests
    • Create a pull request
    • List review comments in a repository
    • Delete a review comment for a pull request
    • Get a review comment for a pull request
    • Update a review comment for a pull request
    • Get a pull request
    • Update a pull request
    • List review comments on a pull request
    • Create a review comment for a pull request
    • Create a reply for a review comment
    • List commits on a pull request
    • List pull requests files
    • Check if a pull request has been merged
    • Merge a pull request
    • Remove requested reviewers from a pull request
    • List requested reviewers for a pull request
    • Request reviewers for a pull request
    • List reviews for a pull request
    • Create a review for a pull request
    • Delete a pending review for a pull request
    • Get a review for a pull request
    • Update a review for a pull request
    • List comments for a pull request review
    • Dismiss a review for a pull request
    • Submit a review for a pull request
    • Update a pull request branch
  • search
    • Search code
    • Search commits
    • Search issues and pull requests
    • Search labels
    • Search repositories
    • Search topics
    • Search users
  • users
    • Get the authenticated user
    • Update the authenticated user
    • Delete an email address for the authenticated user
    • List email addresses for the authenticated user
    • Add an email address for the authenticated user
    • List followers of the authenticated user
    • List the people the authenticated user follows
    • Unfollow a user
    • Check if a person is followed by the authenticated user
    • Follow a user
    • List GPG keys for the authenticated user
    • Create a GPG key for the authenticated user
    • Delete a GPG key for the authenticated user
    • Get a GPG key for the authenticated user
    • List public SSH keys for the authenticated user
    • Create a public SSH key for the authenticated user
    • Delete a public SSH key for the authenticated user
    • Get a public SSH key for the authenticated user
    • List public email addresses for the authenticated user
    • List users
    • Get a user
    • List followers of a user
    • List the people a user follows
    • Check if a user follows another user
    • List GPG keys for a user
    • Get contextual information for a user
    • List public keys for a user
  • billing
  • interactions
  • migrations
  1. enterprise-admin

Create a user

POST
/admin/users
enterprise-admin
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.
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.github.com/admin/users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "octocat@github.com",
    "login": "monalisa"
}'
响应示例响应示例
{
  "avatar_url": "https://github.com/images/error/octocat_happy.gif",
  "events_url": "https://api.github.com/users/octocat/events{/privacy}",
  "followers_url": "https://api.github.com/users/octocat/followers",
  "following_url": "https://api.github.com/users/octocat/following{/other_user}",
  "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
  "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
  "html_url": "https://github.com/octocat",
  "id": 1,
  "login": "octocat",
  "node_id": "MDQ6VXNlcjE=",
  "organizations_url": "https://api.github.com/users/octocat/orgs",
  "received_events_url": "https://api.github.com/users/octocat/received_events",
  "repos_url": "https://api.github.com/users/octocat/repos",
  "site_admin": true,
  "starred_at": "\"2020-07-09T00:17:55Z\"",
  "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
  "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
  "type": "User",
  "url": "https://api.github.com/users/octocat"
}

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Body 参数application/json
email
string 
可选
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.
login
string 
必需
The user's username.
示例

返回响应

🟢201Response
application/json
Body
object (Simple User)  | null 
可选
Simple User
avatar_url
string <uri>
必需
示例值:
https://github.com/images/error/octocat_happy.gif
events_url
string 
必需
示例值:
https://api.github.com/users/octocat/events{/privacy}
followers_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/followers
following_url
string 
必需
示例值:
https://api.github.com/users/octocat/following{/other_user}
gists_url
string 
必需
示例值:
https://api.github.com/users/octocat/gists{/gist_id}
gravatar_id
string  | null 
必需
示例值:
41d064eb2195891e12d0413f63227ea7
html_url
string <uri>
必需
示例值:
https://github.com/octocat
id
integer 
必需
示例值:
1
login
string 
必需
示例值:
octocat
node_id
string 
必需
示例值:
MDQ6VXNlcjE=
organizations_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/orgs
received_events_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/received_events
repos_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/repos
site_admin
boolean 
必需
starred_at
string 
可选
示例值:
"2020-07-09T00:17:55Z"
starred_url
string 
必需
示例值:
https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url
string <uri>
必需
示例值:
https://api.github.com/users/octocat/subscriptions
type
string 
必需
示例值:
User
url
string <uri>
必需
示例值:
https://api.github.com/users/octocat

【GitHub】API开发者 微信交流群

用微信扫右侧二维码,加入【GitHub】API开发者 交流群,互助沟通

扫码加入交流群
上一页
Delete a personal access token
下一页
Delete a user
Built with