Allow configuration of OAuthenticator.scope #523
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
manics
commented
Feb 22, 2018
images/hub/jupyterhub_config.py
Outdated
| @@ -139,7 +140,8 @@ | |||
| org_whitelist = get_config('auth.github.org_whitelist', []) | |||
| if len(org_whitelist) != 0: | |||
| c.GitHubOAuthenticator.github_organization_whitelist = org_whitelist | |||
| c.GitHubOAuthenticator.scope = ['read:org'] # required for private membership | |||
| if not auth_scopes: | |||
| c.OAuthenticator.scope = ['read:org'] # required for private membership | |||
There was a problem hiding this comment.
This feels like the wrong place to embed the logic for default scopes. Maybe this should be left unset since it should work with public members of an org, and an example added to the docs?
|
I've removed the default GitHub scope. I can update the docs after #515 is merged |
minrk
reviewed
Feb 23, 2018
images/hub/jupyterhub_config.py
Outdated
| @@ -186,6 +185,8 @@ | |||
| else: | |||
| raise ValueError("Unhandled auth type: %r" % auth_type) | |||
|
|
|||
| c.OAuthenticator.scope = get_config('auth.scopes', []) | |||
There was a problem hiding this comment.
This overrides the default of the chosen OAuthenticator to an empty list if unset in the helm chart.
To avoid this, use a condition:
auth_scopes = get_config('auth.scopes')
if auth_scopes:
c.OAuthenticator.scope = auth_scopes
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow-up to #501
This allows
OAuthenticator.scopeto be set. The default is[read:org]ifauth.github.org_whitelistis set, otherwiseExamples with Github.
auth.github.org_whitelistunset,auth.scopesunset:auth.github.org_whitelistset,auth.scopesset to[read:org]:auth.github.org_whitelistset,auth.scopesset to[read:org, read:user, user:email]:In theory this property should also work with other OAuth providers, but I don't have an easy way to test.