Skip to content

Commit 775db06

Browse files
authored
Revise README for script usage and permissions
1 parent e3876a9 commit 775db06

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ These scripts provide an emulated Enterprise security manager team to GitHub Ent
44

55
The scripts will give you a list of all organizations in the enterprise as a CSV to work with programmatically, add you to all organizations as an owner, and can create/manage a team with the security manager role to see all GitHub Advanced Security alerts throughout the entire enterprise _without_ having admin rights to that code.
66

7-
:information_source: This uses the [security manager role](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) and parts of the GraphQL API that is available in GitHub.com (free/pro/teams and enterprise), as well as GitHub Enterprise Server versions 3.5 and higher.
7+
> [!NOTE]
8+
> This is an _unofficial_ tool created by Field Security Specialists, and is not officially supported by GitHub.
9+
10+
:information_source: This uses the [security manager role](https://docs.github.com/en/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) and parts of the GraphQL API that is available in GitHub.com (free/pro/teams and enterprise), as well as GitHub Enterprise Server versions 3.5 and higher.
811

912
## Scripts
1013

@@ -14,10 +17,11 @@ The scripts will give you a list of all organizations in the enterprise as a CSV
1417

1518
## How to use it
1619

17-
You need to be an enterprise administrator to use these scripts!
20+
> [!NOTE]
21+
> You need to be an Enterprise administrator to use these scripts
1822
1923
1. Read :point_up: and decide what you want to do.
20-
1. Create a personal access token ([directions](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)) with the `enterprise:admin` scope.
24+
1. Create a [classic personal access token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with the `admin:enterprise` and `admin:org` scopes using an Enterprise administrator account.
2125
1. Clone this repository to a machine that has Python 3 installed.
2226
1. Install the requirements.
2327

@@ -49,6 +53,7 @@ You need to be an enterprise administrator to use these scripts!
4953
## Assumptions
5054
5155
- The security manager team isn't already an existing team that's using team sync [for enterprise](https://docs.github.com/en/enterprise-cloud@latest/admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise) or [for organizations](https://docs.github.com/en/enterprise-cloud@latest/organizations/organizing-members-into-teams/synchronizing-a-team-with-an-identity-provider-group).
56+
- The Enterprise admin account doing this is not intended to be part of the security managers team you are creating (that would conflict with the demotion script)
5257
5358
## Any extra info?
5459

0 commit comments

Comments
 (0)