Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Google] google groups config docs: properties are dictionaries #766

Merged
merged 1 commit into from
Oct 4, 2024
Merged

[Google] google groups config docs: properties are dictionaries #766

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions oauthenticator/google.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ def _userdata_url_default(self):
help="""
Service account keys to use with each domain, see https://developers.google.com/admin-sdk/directory/v1/guides/delegation

This is a mapping of { domain : service-key }.

Required if and only if `allowed_google_groups` or `admin_google_groups`
is configured.
""",
Expand All @@ -74,6 +76,8 @@ def _userdata_url_default(self):
help="""
Username of a G Suite Administrator for the service account to act as.

This is a mapping of { domain : GSuite-administrator }.

Required if and only if `allowed_google_groups` or `admin_google_groups`
is configured.
""",
Expand All @@ -85,6 +89,8 @@ def _userdata_url_default(self):
help="""
Allow members of selected Google groups to sign in.

This is a mapping of { domain : [set of groups] }.

Use of this requires configuration of `gsuite_administrator` and
`google_service_account_keys`.
""",
Expand All @@ -97,6 +103,8 @@ def _userdata_url_default(self):
Allow members of selected Google groups to sign in and consider them as
JupyterHub admins.

This is a mapping of { domain : [set of groups] }.

If this is set and a user isn't part of one of these groups or listed in
`admin_users`, a user signing in will have their admin status revoked.

Expand Down