users
Overview
Name | users |
Type | Resource |
Id | github.users.users |
Fields
Name | Datatype |
---|---|
id | integer |
name | string |
avatar_url | string |
bio | string |
blog | string |
business_plus | boolean |
collaborators | integer |
company | string |
created_at | string |
disk_usage | integer |
email | string |
events_url | string |
followers | integer |
followers_url | string |
following | integer |
following_url | string |
gists_url | string |
gravatar_id | string |
hireable | boolean |
html_url | string |
ldap_dn | string |
location | string |
login | string |
node_id | string |
organizations_url | string |
owned_private_repos | integer |
plan | object |
private_gists | integer |
public-user_avatar_url | string |
public-user_bio | string |
public-user_blog | string |
public-user_collaborators | integer |
public-user_company | string |
public-user_created_at | string |
public-user_disk_usage | integer |
public-user_email | string |
public-user_events_url | string |
public-user_followers | integer |
public-user_followers_url | string |
public-user_following | integer |
public-user_following_url | string |
public-user_gists_url | string |
public-user_gravatar_id | string |
public-user_hireable | boolean |
public-user_html_url | string |
public-user_id | integer |
public-user_location | string |
public-user_login | string |
public-user_name | string |
public-user_node_id | string |
public-user_organizations_url | string |
public-user_owned_private_repos | integer |
public-user_plan | object |
public-user_private_gists | integer |
public-user_public_gists | integer |
public-user_public_repos | integer |
public-user_received_events_url | string |
public-user_repos_url | string |
public-user_site_admin | boolean |
public-user_starred_url | string |
public-user_subscriptions_url | string |
public-user_suspended_at | string |
public-user_total_private_repos | integer |
public-user_twitter_username | string |
public-user_type | string |
public-user_updated_at | string |
public-user_url | string |
public_gists | integer |
public_repos | integer |
received_events_url | string |
repos_url | string |
site_admin | boolean |
starred_url | string |
subscriptions_url | string |
suspended_at | string |
total_private_repos | integer |
twitter_username | string |
two_factor_authentication | boolean |
type | string |
updated_at | string |
url | string |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get_authenticated | SELECT | If the authenticated user is authenticated with an OAuth token with the user scope, then the response lists public and private profile information.If the authenticated user is authenticated through OAuth without the user scope, then the response lists only public profile information. | |
get_by_username | SELECT | username | 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 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 plan information' below"The email key in the following response is the publicly visible email address from your GitHub 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. 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". |
update_authenticated | EXEC | Note: If your email is set to private and you send an email parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API. |