Sobre los informes para GitHub Enterprise Server
Si necesitas obtener información sobre los usuarios, las organizaciones y los repositorios de tu instancia de GitHub Enterprise Server, puedes recuperar datos mediante la API de REST. Para más información, consulta Acerca de la API de REST.
Es posible que la API de REST no proporcione todos los datos que deseas y se requiera algo de conocimiento técnico para usarla. Como alternativa, puedes generar informes que contengan información general de usuarios, organizaciones y repositorios en la instancia.
Descarga de informes mediante la interfaz de usuario web
- Desde una cuenta administrativa de GitHub Enterprise Server, en la esquina superior derecha de cualquier página, haga clic en .
- En la barra lateral de la izquierda, haz clic en Informes.
- Junto al informe que deseas descargar, haz clic en Descargar.
Puedes descargar archivos CSV que reflejen la siguiente información:
- Todos los usuarios
- Todos los usuarios activos
- Todos los usuarios inactivos
- Todos los usuarios que han sido suspendidos
- Todas las organizaciones
- todos los repositorios.
Descarga de informes mediante programación
También puedes acceder a los informes mediante programación a través de autenticación HTTP estándar y un personal access token (classic). Debes usar un personal access token (classic) con el ámbito site_admin. Para más información, consulta Administración de tokens de acceso personal.
Por ejemplo, puedes descargar el informe "todos los usuarios" utilizando curl:
curl --remote-name \
--location \
--user 'USERNAME:TOKEN' \
http(s)://HOSTNAME/stafftools/reports/all_users.csv
Para acceder a los demás informes mediante programación, reemplace all_users por active_users, dormant_users, suspended_users, all_organizations o all_repositories.
Note
La solicitud curl inicial devolverá una respuesta 202 HTTP si no hay informes en caché disponibles. La instancia generará un informe en segundo plano. Puedes enviar una segunda solicitud para descargar el informe. Puede usar una contraseña o un token de OAuth con el ámbito site_admin en lugar de una contraseña.
Informes del usuario
| Clave | Descripción |
|---|---|
created_at | Cuándo fue creada la cuenta de usuario (como una marca de tiempo ISO 8601) |
id | ID de la cuenta para el usuario o la organización |
login | Nombre de inicio de sesión de la cuenta |
email | Dirección principal de correo electrónico de la cuenta |
role | Si la cuenta es de un usuario administrador o de un usuario común |
suspended? | Si la cuenta ha sido suspendida |
last_logged_ip | La dirección IP más reciente que se registró en la cuenta |
repos | Cantidad de repositorios que posee la cuenta |
ssh_keys | Cantidad de claves SSH registradas en la cuenta |
org_memberships | Cantidad de organizaciones a las que pertenece la cuenta |
dormant? | Si la cuenta está inactiva |
last_active | Cuándo la cuenta estuvo activa por última vez (como una marca de tiempo ISO 8601) |
raw_login | Información de inicio de sesión sin procesar (en formato JSON) |
2fa_enabled? | Si el usuario ha habilitado autenticación de dos factores |
Informes de la organización
| Clave | Descripción |
|---|---|
id | Identificador de la organización |
created_at | Cuándo se creó la organización |
login | Nombre de inicio de sesión de la organización |
email | Dirección principal de correo electrónico de la organización |
owners | Cantidad de propietarios de la organización |
members | Cantidad de miembros de la organización |
teams | Cantidad de equipos de la organización |
repos | Cantidad de repositorios de la organización |
2fa_required? | Si la organización requiere autenticación de dos factores |
Informes del repositorio
| Clave | Descripción |
|---|---|
created_at | Cuándo fue creado el repositorio |
owner_id | ID del propietario del repositorio |
owner_type | Si el repositorio es propiedad de un usuario o de una organización |
owner_name | Nombre del propietario del repositorio |
id | ID del repositorio |
name | Nombre del repositorio |
visibility | Si el repositorio es público o privado |
readable_size | El tamaño del repositorio en un formato legible |
raw_size | Tamaño del repositorio como un número |
collaborators | Cantidad de colaboradores del repositorio |
fork? | Si el repositorio es una bifurcación |
deleted? | Si el repositorio ha sido borrado |