Sobre os relatórios para GitHub Enterprise Server
Caso precise obter informações sobre os usuários, as organizações e os repositórios do sua instância do GitHub Enterprise Server, você pode buscar dados usando a API REST. Para saber mais, confira Sobre a API REST.
A API REST pode não fornecer todos os dados necessários e ainda requer um pouco de conhecimento técnico. Como alternativa, você pode gerar relatórios contendo visões gerais de usuários, organizações e repositórios em sua instância.
Baixando relatórios usando a interface do usuário da Web
- Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .
- Na barra lateral esquerda, clique em Relatórios.
- Ao lado do relatório que você deseja baixar, clique em Baixar.
Você pode baixar arquivos CSV que relatam as seguintes informações:
- Todos os usuários
- Todos os usuários ativos
- Todos os usuários inativos
- Todos os usuários suspensos
- Todas as organizações
- Todos os repositórios
Baixando relatórios programaticamente
Você também pode acessar relatórios programaticamente por meio de autenticação HTTP padrão e um personal access token (classic). Você deve usar um personal access token (classic) com o escopo site_admin. Para saber mais, confira Gerenciar seus tokens de acesso pessoal.
Por exemplo, você pode baixar o relatório "todos os usuários" com curl:
curl --remote-name \
--location \
--user 'USERNAME:TOKEN' \
http(s)://HOSTNAME/stafftools/reports/all_users.csv
Para acessar os outros relatórios por meio de programação, substitua all_users por active_users, dormant_users, suspended_users, all_organizations ou all_repositories.
Note
A solicitação inicial do cURL retornará uma resposta HTTP 202 se não houver relatórios armazenados em cache disponíveis. Sua instância gerará um relatório em segundo plano. Você pode enviar uma segunda solicitação para baixar o relatório. Você pode usar uma senha ou um token OAuth com o escopo site_admin no lugar de uma senha.
Relatórios de usuário
| Chave | Descrição |
|---|---|
created_at | Momento da criação da conta do usuário (carimbo de data/hora ISO 8601) |
id | ID da conta de usuário ou organização |
login | Nome de login da conta |
email | Endereço de e-mail principal da conta |
role | Conta de administrador ou usuário regular |
suspended? | Se a conta foi suspensa |
last_logged_ip | Endereço IP mais recente a fazer login na conta |
repos | Número de repositórios pertencentes à conta |
ssh_keys | Número de chaves SSH registradas na conta |
org_memberships | Número de organizações às quais a conta pertence |
dormant? | Se a conta está inativa |
last_active | Última vez em que a conta ficou ativa (carimbo de data/hora ISO 8601) |
raw_login | Informações brutas de login (formato JSON) |
2fa_enabled? | Se o usuário habilitou a autenticação de dois fatores |
Relatórios da organização
| Chave | Descrição |
|---|---|
id | ID da organização |
created_at | Momento de criação da organização |
login | Nome de login da organização |
email | Endereço de e-mail principal da organização |
owners | Número de proprietários da organização |
members | Número de integrantes da organização |
teams | Número de equipes da organização |
repos | Número de repositórios da organização |
2fa_required? | Se a organização exige autenticação de dois fatores |
Relatórios do repositório
| Chave | Descrição |
|---|---|
created_at | Momento de criação do repositório |
owner_id | ID do proprietário do repositório |
owner_type | Se o repositório pertence a um usuário ou organização |
owner_name | Nome do proprietário do repositório |
id | ID do repositório |
name | Nome do repositório |
visibility | Se o repositório é público ou privado |
readable_size | Tamanho do repositório em formato legível por humanos |
raw_size | Tamanho do repositório como número |
collaborators | Número de colaboradores do repositório |
fork? | Se o repositório é uma bifurcação |
deleted? | Se o repositório foi excluído |