のレポートについて
お使いの GitHub Enterprise Server インスタンス にある、ユーザー、組織、リポジトリの情報が必要な場合、REST API を使って、データをフェッチします。 詳しくは、「REST API について」をご覧ください。
REST API は、必要なすべてのデータを提供しない可能性があり、使用するのには専門知識が必要です。 または、インスタンス上のユーザー、組織、リポジトリの概要を含むレポートを作成することもできます。
Web UI を使用したレポートのダウンロード
- の管理アカウントから、任意のページの右上隅で をクリックします。
- 左側のサイドバーで、[レポート] をクリックします。
- ダウンロードするレポートの横にある [ダウンロード] をクリックします。
次の情報を報告する CSV ファイルをダウンロードできます。
- すべてのユーザー
- すべてのアクティブ ユーザー
- すべての休眠ユーザー
- 一時停止されているすべてのユーザー
- すべての組織
- すべてのリポジトリ
プログラムによるレポートのダウンロード
標準の HTTP 認証と personal access token (classic) を使用してプログラムでレポートにアクセスすることもできます。 site_admin スコープとともに personal access token (classic) を使う必要があります。 詳しくは、「個人用アクセス トークンを管理する」をご覧ください。
たとえば、cURL を使用して "all users" レポートをダウンロードすることができます。
curl --remote-name \
--location \
--user 'USERNAME:TOKEN' \
http(s)://HOSTNAME/stafftools/reports/all_users.csv
プログラムで他のレポートにアクセスするには、all_users を active_users、dormant_users、suspended_users、all_organizations、または all_repositories に置き換えます。
Note
キャッシュされたレポートがない場合、最初の cURL 要求からは HTTP 202 応答が返されます。 インスタンスがバックグラウンドでレポートを生成します。 もう一度リクエストを送れば、その報告をダウンロードすることができます。 パスワードを使用するか、パスワードの代わりに、site_admin スコープと併せて OAuth トークンを使用することができます。
ユーザ報告
| Key | 説明 |
|---|---|
created_at | ユーザアカウントの作成時間（ISO 8601 のタイムスタンプ） |
id | ユーザまたは Organization のアカウント ID |
login | アカウントのログイン名 |
email | アカウントのプライマリメールアドレス |
role | アカウントがアドミンか一般ユーザか |
suspended? | アカウントが停止されているか |
last_logged_ip | 最後にアカウントにログインしたときの IP アドレス |
repos | アカウントが所有しているリポジトリの数 |
ssh_keys | アカウントに登録されているSSHキーの数 |
org_memberships | アカウントが所属している Organization の数 |
dormant? | アカウントが休眠であるかどうか |
last_active | アカウントが最後にアクティブだったとき（ISO 8601 のタイムスタンプ） |
raw_login | （JSON フォーマットでの）未処理のログイン情報 |
2fa_enabled? | ユーザが二段階認証を有効にしているかどうか |
Organization の報告
| Key | 説明 |
|---|---|
id | Organization ID |
created_at | Organization の作成時間 |
login | Organization のログイン名 |
email | Organization のプライマリメールアドレス |
owners | Organization のオーナーの数 |
members | Organization のメンバーの数 |
teams | Organization のチームの数 |
repos | Organization のリポジトリの数 |
2fa_required? | Organization が二段階認証を有効にしているかどうか |
リポジトリ の報告
| Key | 説明 |
|---|---|
created_at | リポジトリの作成時間 |
owner_id | リポジトリのコードオーナーの ID |
owner_type | リポジトリの所有者がユーザか Organization か |
owner_name | リポジトリの所有者の名前 |
id | リポジトリの ID |
name | リポジトリ名です |
visibility | リポジトリが公開かプライベートか |
readable_size | 人間が読める形式のリポジトリのサイズ |
raw_size | 数字でのリポジトリのサイズ |
collaborators | リポジトリのコラボレータの数 |
fork? | リポジトリがフォークであるかどうか |
deleted? | リポジトリが削除されているかどうか |