Add org/team configuration relevant urls to github enterprise sample config

eikehartmann · eikehartmann · commit 7ba6f2ce5c14 · 2020-02-09T21:13:07.000+01:00
diff --git a/config/config.yml_example_github_enterprise b/config/config.yml_example_github_enterprise
@@ -15,6 +15,15 @@ vouch:
   # instead of setting specific domains you may prefer to allow all users...
   # set allowAllUsers: true to use Vouch Proxy to just accept anyone who can authenticate at the configured provider
   # allowAllUsers: true
+  # set teamWhitelist: to list of teams and/or GitHub organizations
+  # When putting an organization id without a slash, it will allow all (public) members from the organization.
+  # The client will try to read the private organization membership using the client credentials, if that's not possible
+  # due to access restriction, it will try to evaluate the publicly visible membership.
+  # Allowing members form a specific team can be configured by qualifying the team with the organization, separated by
+  # a slash.
+  # teamWhitelist:
+  # - myOrg
+  # - myOrg/myTeam
 
 oauth:
   # create a new OAuth application at:
@@ -25,6 +34,10 @@ oauth:
   auth_url: https://githubenterprise.yoursite.com/login/oauth/authorize
   token_url: https://githubenterprise.yoursite.com/login/oauth/access_token
   user_info_url: https://githubenterprise.yoursite.com/api/v3/user?access_token=
+  # relevant only if teamWhitelist is configured; colon-prefixed parts are parameters that
+  # will be replaced with the respective values.
+  user_team_url: https://githubenterprise.yoursite.com/api/v3/orgs/:org_id/teams/:team_slug/memberships/:username?access_token=
+  user_org_url: https://githubenterprise.yoursite.com/api/v3/orgs/:org_id/members/:username?access_token=
   # these GitHub OAuth defaults are set for you..
   # scopes:
   #   - user
