Skip to content

Latest commit

 

History

History
35 lines (28 loc) · 1.73 KB

README.md

File metadata and controls

35 lines (28 loc) · 1.73 KB
Raw

User access Report for GitHub Enterprise

This Node script can be used on GitHub Enterprise (Server or Cloud) to get a specific user's access report for repositories owned by the Enterprise. It will return a .csv file with a report of all repositories the user has access towards, and what level of access. It requires a GitHub Personal Access Token with the following scopes on a user that is an organization owner for every organization in the Enterprise:

  • admin:enterprise
  • admin:org
  • admin:repo

How to run

  • Install the node modules
    • npm install
  • Create .env with needed variables based on .env.example
    • The OUTPUT_FOLDER specified will be created if needed, and the generated .csv will be within
  • Run the script and define the user
    • node user-access-report.js --user <someUserHandle>

Report layout

Once the script has run to completion, you will be presented with a report in the format below:

Filename: user-<username>-report-<epoch_timestamp>.csv

Organization,Repository,AccessLevel
org1,repo1,triage
org1,repo2,read
org2,repo1,write
org2,repo2,admin
SomeOtherOrg,someRepo,maintain
...

Caveats

This script requires that the GITHUB_TOKEN provided have the scopes listed above, and the user creating the token needs to be an organization owner of every organization in the Enterprise to get a complete report.

  • If the GITHUB_TOKEN does not have organization owner access, the end report will not include the organization

If this is ran on GitHub Enterprise Server, this will only report the Enterprise Owned repositories, not personal repositories. This includes that if the user is an outside collaborator on another user's personal repository, it will not be in the report.