jupyterhub / oauthenticator

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

[CILogon] Rename `allowed_idps` to `idps` in a non-breaking way? #683

Open consideRatio opened 12 months ago

consideRatio commented 12 months ago

I think the name allowed_idps causes some confusion in oauthenticator v16, and that it should be non-breakingly renamed to just idps with a deprecation warning for users still using the allowed_idps name.

With a name like idps, there is no hint about users from a specific ipd would be allowed or simiarly. Configuring idps is about describing what users we can authenticate/recognize, while allowed refers to what users we authorize/allow. Since configuring an idp to be used to authenticate a user doesn't go hand in hand with authorizing a user, I think it should be renamed for clarity.

Together with the proposal in #682, the config for CILogon that is associated with authorizing users then become the following:

Proposal

Rename allowed_idps to idps, making allowed_idps still work as an alias for idps, but come with a deprecation warning.