add dedicated doc on details of allowing access #729
Conversation
| # when combined with other allow options | ||
| OAuthenticator.class_traits()[ | ||
| "allowed_users" | ||
| ].help = """ |
There was a problem hiding this comment.
The base Authenticator.allowed_users docstring gives the wrong impression of how it relates to other allow config, since the base Authenticator doesn't have other allow config. Patching this way allows us to modify the docstring, which in turn shows up in our docs, without redeclaring the trait.
|
It's unclear to me a bit whether things like allowed_idps/hosted_domain expanations belong here vs the provider-specific doc pages |
Those two are odd ducks, they shouldn't be classified as allow config. They are requirements to authenticate currently, and hosted_domain could move to be part of the blocked check if the implementation is refactored. See #683 |
Co-authored-by: Simon Li <[email protected]>
Co-authored-by: Erik Sundell <[email protected]>
|
I'll reflect further on #729 (comment), but i think there isn't an action point remaining in this PR about it - this LGTM and can be merged. @minrk - ok to merge? |
|
Thanks for the thoughtful reviews! |
Rendered doc: https://oauthenticator--729.org.readthedocs.build/en/729/topic/allowing.html
closes #727