Usuários

Enterprise Cloud

Enterprise Server 3.10

Enterprise Server 3.11

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

Toda a documentação do GitHub é de código aberto. Encontrou informações erradas ou confusas? Envie uma solicitação de pull.

Ajude-nos a tornar esses documentos ótimos!

Ações

Digite um termo de pesquisa a encontrar na Documentação do GitHub.

Usuários - GitHub AE Docs

Use a API REST para obter informações públicas e privadas sobre usuários autenticados.

Início Rápido

Comparando APIs do GitHub

Recursos na API REST

Limites de taxa

Tipos de mídia

Autenticação

Manter credenciais de API seguras

Solução de problemas

Libraries

Tipos de eventos de problemas

Tipos de eventos do GitHub

Pontos de extremidade para tokens de instalação do aplicativo GitHub

Pontos de extremidade para tokens de usuário do aplicativo GitHub

Permissões para aplicativos GitHub

Visão geral

Usando a API

Script com JavaScript

Script com Ruby

Descobrir recursos para um usuário

Entregar implantações

Representar dados como gráficos

Trabalhar com comentários

Paginação

Criar um servidor de CI

Práticas recomendadas

Introdução – banco de dados Git

Introdução – Verificações

Criptografar segredos

Guides

Artifacts

Permissões

Segredos

Grupos de runner auto-hospedados

Executores auto-hospedados

Trabalhos de fluxo de trabalho

Execução de fluxo de trabalho

Fluxos de trabalho

Eventos

Feeds

Notificações

Marcar com uma estrela

Observando

Atividade

Aplicativos GitHub

Instalações

Autorizações do OAuth

Webhooks

Aplicativos

Branches

Branches protegidos

Execuções de verificação

conjuntos de verificações

Verificações

Verificação de código

Códigos de conduta

Colaboradores

Convites

Confirmações

Comentários de commit

Status do commit

Chaves de implantação

Políticas de branch de implantação

Implantações

Ambientes

Status da implantação

Emojis

Estatísticas de admin

Anúncio

Log de auditoria

Webhooks globais

Licença

Organizações

Ambientes Pre-receive

Administração de empresas

Gists

Comentários

Blobs

Referências

Marcações

Árvores

Banco de dados do Git

Gitignore

Problemas

Responsáveis

Rótulos

Marcos

Linha do tempo

Licenças

Markdown

Estatísticas

Métricas

Migrações

Membros

Colaboradores externos

Páginas

Boards

Cartões

Colunas

Project boards

Pulls

Comentários de opiniões

Solicitações de revisão

Análises

Limite de taxa

Reações

Versões

Ativos de versões

Links automáticos

Sumário

Garfos

Git LFS

Repositórios

Search

Verificação de segredo

Teams

Comentários da discussão

Discussões

Grupos externos

Seguidores

Chaves GPG

Chaves SSH do Git

API REST

Response with public and private profile information

monalisa octocat

Medium

Private User

Public User

Response with public profile information

If the authenticated user is authenticated with an OAuth token with the <code>user</code> scope, then the response lists public and private profile information.
If the authenticated user is authenticated through OAuth without the <code>user</code> scope, then the response lists only public profile information.

Get the authenticated user

name

The publicly visible email address of the user.

email

blog

The new Twitter username of the user.

twitter_username

company

location

The new hiring availability of the user.

hireable

The new short biography of the user.

Note: If your email is set to private and you send an <code>email</code> 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.

Validation failed, or the endpoint has been spammed.

Update the authenticated user

Simple User

Lists all users, in the order that they signed up on GitHub AE. This list includes personal user accounts and organization accounts.
Note: Pagination is powered exclusively by the <code>since</code> parameter. Use the <a href="https://docs.github.com/github-ae@latest/rest/guides/using-pagination-in-the-rest-api#using-link-headers">Link header</a> to get the URL for the next page of users.

A user ID. Only return users with an ID greater than this ID.

since

The number of results per page (max 100).

per_page

List users

Response with GitHub plan information

Provides publicly available information about someone with a GitHub account.
GitHub Apps with the <code>Plan</code> user permission can use this endpoint to retrieve information about a user's GitHub AE plan. The GitHub App must be authenticated as a user. See "<a href="https://docs.github.com/github-ae@latest/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/">Identifying and authorizing users for GitHub Apps</a>" for details about authentication. For an example response, see 'Response with GitHub AE plan information' below"
The <code>email</code> key in the following response is the publicly visible email address from your GitHub AE <a href="https://github.com/settings/profile">profile page</a>. 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 <code>email</code>, then it will have a value of <code>null</code>. You only see publicly visible email addresses when authenticated with GitHub AE. For more information, see <a href="https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#authentication">Authentication</a>.
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 "<a href="https://docs.github.com/github-ae@latest/rest/users/emails">Emails API</a>".

The handle for the GitHub user account.

username

Get a user

Hovercard

Provides hovercard information when authenticated through basic auth or OAuth with the <code>repo</code> scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.
The <code>subject_type</code> and <code>subject_id</code> parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about <code>octocat</code> who owns the <code>Spoon-Knife</code> repository via cURL, it would look like this:
<pre><code class="hljs language-shell"> curl -u username:token
 https://api.github.com/users/octocat/hovercard?subject_type=repository&#x26;subject_id=1300192
</code></pre>

Identifies which additional information you'd like to receive about the person's hovercard. Can be <code>organization</code>, <code>repository</code>, <code>issue</code>, <code>pull_request</code>. Required when using <code>subject_id</code>.

subject_type

Uses the ID for the <code>subject_type</code> you specified. Required when using <code>subject_type</code>.