jupyterhub / oauthenticator

OAuth + JupyterHub Authenticator = OAuthenticator
https://oauthenticator.readthedocs.io
BSD 3-Clause "New" or "Revised" License
414 stars 366 forks source link

Provide high level docs on how allow/disallow config works #727

Closed consideRatio closed 9 months ago

consideRatio commented 9 months ago

This is the gist of it how allow/disallow config works is that each user needs to:

  1. Successfully authenticate

    This is the phase where a username is determined, and misc properties of the user such as admin status.

    Failure to authenticate can stem from GoogleOAuthenticator.hosted_domain or CILogonOAuthenticator.allowed_idps config that influences the ability to determine the username.

  2. Not be blocked/disallowed

    Only Authenticator.blocked_users is disallowing config

  3. Be allowed

    Examples of such allowing config is: Authenticator.allow_users, Authenticator.admin_users, OAuthenticator.allow_all, OAuthenticator.allow_existing_users, GitHubOAuthenticator.allowed_organizations, ...)

minrk commented 9 months ago

Took a stab at this in #729