Skip to main content

Esta versão do GitHub Enterprise Server foi descontinuada em 2024-03-26. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise Server. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

Acessando relatórios para sua instância

Você pode baixar relatórios com informações sobre usuários, organizações e repositórios em sua instância do GitHub Enterprise Server.

Quem pode usar esse recurso?

Enterprise owners can download reports for a GitHub Enterprise Server instance.

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 obter mais informações, 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

  1. Em uma conta administrativa no GitHub Enterprise Server, no canto superior direito de qualquer página, clique em .
  2. Na barra lateral esquerda, clique em Relatórios.
  3. 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. Você deve usar um personal access token com o escopo site_admin. Para obter mais informações, 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.

Observação: a solicitação curl inicial 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

ChaveDescrição
created_atMomento da criação da conta do usuário (carimbo de data/hora ISO 8601)
idID da conta de usuário ou organização
loginNome de login da conta
emailEndereço de e-mail principal da conta
roleConta de administrador ou usuário regular
suspended?Se a conta foi suspensa
last_logged_ipEndereço IP mais recente a fazer login na conta
reposNúmero de repositórios pertencentes à conta
ssh_keysNúmero de chaves SSH registradas na conta
org_membershipsNú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_loginInformações brutas de login (formato JSON)
2fa_enabled?Se o usuário habilitou a autenticação de dois fatores

Relatórios da organização

ChaveDescrição
idID da organização
created_atMomento de criação da organização
loginNome de login da organização
emailEndereço de e-mail principal da organização
ownersNúmero de proprietários da organização
membersNúmero de integrantes da organização
teamsNúmero de equipes da organização
reposNúmero de repositórios da organização
2fa_required?Se a organização exige autenticação de dois fatores

Relatórios do repositório

ChaveDescrição
created_atMomento de criação do repositório
owner_idID do proprietário do repositório
owner_typeSe o repositório pertence a um usuário ou organização
owner_nameNome do proprietário do repositório
idID do repositório
nameNome do repositório
visibilitySe o repositório é público ou privado
readable_sizeTamanho do repositório em formato legível por humanos
raw_sizeTamanho do repositório como número
collaboratorsNúmero de colaboradores do repositório
fork?Se o repositório é uma bifurcação
deleted?Se o repositório foi excluído