Usuarios

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 la documentación de GitHub es de código abierto. ¿Ve algo incorrecto o que no esté claro? Envíe una solicitud de incorporación de cambios.

¡Ayúdanos a hacer geniales estos documentos!

Consulta el vídeo de esta transcripción.

Acciones

Introduzca un término de búsqueda para encontrarlo en la documentación de GitHub.

Usuarios - GitHub AE Docs

La API de REST permite obtener información pública y privada sobre los usuarios autenticados.

Inicio rápido

Comparación de las API de GitHub

Recursos en la API de REST

Rate limits

Tipos de medios

Autenticación

Protección de las credenciales de API

Solución de problemas

Libraries

Tipos de eventos de los informes de problemas

Tipos de evento de GitHub

Puntos de conexión para tokens de instalación de aplicaciones de GitHub

Puntos de conexión para tokens de usuario de aplicaciones de GitHub

Permisos para instancias de GitHub App

Información general

Uso de la API

Script con JavaScript

Script con Ruby

Descubrimiento de recursos para un usuario

Entregar despliegues

Representar los datos en gráficas

Trabajar con los comentarios

Paginación

Crear un servidor de IC

procedimientos recomendados

Introducción: base de datos de Git

Introducción: Comprobaciones

Cifrado de secretos

Guías

Artifacts

Permisos

Secretos

Grupos de ejecutores auto-hospedados

Ejecutores autohospedados

Jobs de los flujos de trabajo

Ejecuciones de flujo de trabajo

Workflows

Eventos

Fuentes

Notificaciones

Marcar con una estrella

Observando

Actividad

Aplicaciones de GitHub

Instalaciones

Autorizaciones de OAuth

webhooks

Aplicaciones

Ramas

Ramas protegidas

Ejecuciones de Verificación

Conjuntos de Verificaciones

Comprobaciones

Examen del código

Códigos de conducta

Colaboradores

Invitaciones

Confirmaciones

Comentarios sobre confirmación de cambios

Estados de confirmación

Claves de implementación

Directivas de rama de implementación

Implementaciones

Entornos

Estados de despliegue

Emojis

Estadísticas de los Administradores

Anuncio

Registro de auditoría

Webhooks globales

Licencia

Las organizaciones

Ambientes de pre-recepción

Administración empresarial

Gists

Comentarios

Datos BLOB

Referencias

Etiquetas

Árboles

Base de datos de Git

Gitignore

Incidencias

Asignados

Hitos

Escala de tiempo

Licencias

Markdown

Estadísticas

Métricas

Migraciones

Miembros

Colaboradores externos

Páginas

Boards

Cards

Columnas

Project boards

Extracciones

Revisar comentarios

Solicitudes de revisión

Revisiones

Límite de frecuencia

Reacciones

Versiones

Recursos de versión

Vínculos automáticos

Contenido

Horquillas

Git LFS

Repositorios

Webhooks

Search

Análisis de secretos

Teams

Comentarios de debate

Debates

Grupos externos

Seguidores

Claves GPG

Claves SSH de Git

API DE 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>.