Skip to content

Commit dc0bbd7

Browse files
BED-9472: document optional privileged collection
1 parent 1ea4bae commit dc0bbd7

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,23 @@ A token with enterprise SCIM access is used to collect both `/scim/v2/enterprise
4848

4949
Enterprise roles, including the built-in `members` role, are emitted through `GH_HasRole` and granular enterprise capability relationships. Only capability relationships with a confirmed privilege path are traversable; descriptive permissions such as `GH_WriteEnterpriseSso` remain non-traversable.
5050

51+
### Optional privileged collection
52+
53+
The collector runs successfully with the documented read-only permission set. Some higher-fidelity relationships require optional non-read-only permissions because GitHub exposes the supporting read APIs behind privileged permission names:
54+
55+
- Organization `Members: write` enables external group mapping collection for IdP-synced teams, which allows the converter to emit `SCIM_Provisioned` edges from `SCIM_Group` to `GH_Team`. This is useful when the organization uses team synchronization with an external identity provider; if no GitHub teams are linked to external groups, this permission does not add graph data.
56+
- Classic PAT scope `manage_runners:enterprise` enables enterprise self-hosted runner group and runner collection. This is useful when the enterprise has enterprise-scoped runner groups or runners, especially runner groups shared into organizations; if all runners are organization- or repository-scoped, this scope does not add graph data.
57+
58+
If these optional permissions are not granted, OpenHound skips the affected resources and continues collecting the rest of the GitHub environment.
59+
5160
[![Python Version](https://img.shields.io/badge/Python-3.13-brightgreen.svg)](#about)
5261

5362
## Getting Started
5463

55-
Follow the OpenHound docs to get started:
64+
Follow the OpenHound GitHub collector docs to get started:
5665

57-
- [OpenHound Documentation](https://bloodhound.specterops.io/openhound/overview)
66+
- [GitHub collector overview](https://bloodhound.specterops.io/openhound/collectors/github/overview)
67+
- [Configure the collector](https://bloodhound.specterops.io/openhound/collectors/github/collect-data)
68+
- [Configure an organization GitHub App](https://bloodhound.specterops.io/openhound/collectors/github/configure-app)
69+
- [Configure an enterprise GitHub App](https://bloodhound.specterops.io/openhound/collectors/github/configure-enterprise-app)
70+
- [Configure a personal access token](https://bloodhound.specterops.io/openhound/collectors/github/configure-pat)

0 commit comments

Comments
 (0)