Get a user

Provides publicly available information about someone with a GitHub account.

GitHub Apps with the Plan user permission can use this endpoint to retrieve information about a user's GitHub Enterprise Server plan. The GitHub App must be authenticated as a user. See "Identifying and authorizing users for GitHub Apps" for details about authentication. For an example response, see 'Response with GitHub Enterprise Server plan information' below"

The email key in the following response is the publicly visible email address from your GitHub Enterprise Server profile page. When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for email, then it will have a value of null. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see Authentication.

The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "Emails API".

{ "avatar_url": "https://github.com/images/error/octocat_happy.gif", "bio": "There once was...", "blog": "https://github.com/blog", "business_plus": true, "collaborators": 8, "company": "GitHub", "created_at": "2008-01-14T04:33:35Z", "disk_usage": 10000, "email": "octocat@github.com", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "followers": 20, "followers_url": "https://api.github.com/users/octocat/followers", "following": 0, "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", "hireable": true, "html_url": "https://github.com/octocat", "id": 1, "ldap_dn": "string", "location": "San Francisco", "login": "octocat", "name": "monalisa octocat", "node_id": "MDQ6VXNlcjE=", "organizations_url": "https://api.github.com/users/octocat/orgs", "owned_private_repos": 100, "plan": { "collaborators": 0, "name": "string", "private_repos": 0, "space": 0 }, "private_gists": 81, "public_gists": 1, "public_repos": 2, "received_events_url": "https://api.github.com/users/octocat/received_events", "repos_url": "https://api.github.com/users/octocat/repos", "site_admin": true, "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "suspended_at": "2019-08-24T14:15:22Z", "total_private_repos": 100, "two_factor_authentication": true, "type": "User", "updated_at": "2008-01-14T04:33:35Z", "url": "https://api.github.com/users/octocat" }

返回响应

🟢200Response

application/json

Body

可选

One of

Private User

Public User

Private User

avatar_url

string <uri>

必需

示例值:

https://github.com/images/error/octocat_happy.gif

bio

string | null

必需

示例值:

There once was...

blog

string | null

必需

示例值:

https://github.com/blog

business_plus

boolean

可选

collaborators

integer

必需

示例值:

company

string | null

必需

示例值:

GitHub

created_at

string <date-time>

必需

示例值:

2008-01-14T04:33:35Z

disk_usage

integer

必需

示例值:

10000

string <email> | null

必需

示例值:

octocat@github.com

events_url

string

必需

示例值:

https://api.github.com/users/octocat/events{/privacy}

followers

integer

必需

示例值:

followers_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/followers

following

integer

必需

示例值:

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

hireable

boolean | null

必需

html_url

string <uri>

必需

示例值:

https://github.com/octocat

integer

必需

示例值:

ldap_dn

string

可选

location

string | null

必需

示例值:

San Francisco

string

必需

示例值:

octocat

name

string | null

必需

示例值:

monalisa octocat

node_id

string

必需

示例值:

MDQ6VXNlcjE=

organizations_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/orgs

owned_private_repos

integer

必需

示例值:

100

plan

object

可选

private_gists

integer

必需

示例值:

public_gists

integer

必需

示例值:

public_repos

integer

必需

示例值:

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_url

string

必需

示例值:

https://api.github.com/users/octocat/starred{/owner}{/repo}

subscriptions_url

string <uri>

必需

示例值:

https://api.github.com/users/octocat/subscriptions

suspended_at

string <date-time> | null

可选

total_private_repos

integer

必需

示例值:

100

two_factor_authentication

boolean

必需

示例值:

true

type

string

必需

示例值:

User

updated_at

string <date-time>

必需

示例值:

2008-01-14T04:33:35Z

url

string <uri>

必需

示例值:

https://api.github.com/users/octocat

🟢202成功

🟠404404

请求参数

返回响应