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.

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

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

Closed
consideRatio opened this issue Feb 7, 2024 · 1 comment · Fixed by #729
Closed

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

consideRatio opened this issue Feb 7, 2024 · 1 comment · Fixed by #729

Comments

@consideRatio
Copy link
Member

consideRatio commented Feb 7, 2024

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
Copy link
Member

minrk commented Feb 9, 2024

Took a stab at this in #729

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants