From e5ebcf518a9999a811d77ad77ccbc5793bcaf5e0 Mon Sep 17 00:00:00 2001 From: Alexander Matyushentsev Date: Thu, 15 Nov 2018 09:24:21 -0800 Subject: [PATCH] Update github connector documentation --- Documentation/connectors/github.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/Documentation/connectors/github.md b/Documentation/connectors/github.md index c07ac4c3..ddf11869 100644 --- a/Documentation/connectors/github.md +++ b/Documentation/connectors/github.md @@ -42,8 +42,12 @@ connectors: # For example if a user is part of the "engineering" team of the "coreos" # org, the group claim would include "coreos:engineering". # - # A user MUST be a member of at least one of the following orgs to + # If orgs are specified in the config then user MUST be a member of at least one of the specified orgs to # authenticate with dex. + # + # If neither 'org' nor 'orgs' are specified in the config then user authenticate with ALL user's Github groups. + # Typical use case for this setup: + # provide read-only access to everyone and give full permissions if user has 'my-organization:admins-team' group claim. orgs: - name: my-organization # Include all teams as claims.