-
Notifications
You must be signed in to change notification settings - Fork 67
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
DOCS: Document logging out of CILogon #974
Merged
choldgraf
merged 12 commits into
2i2c-org:master
from
GeorgianaElena:cilogon-logout-note
Feb 9, 2022
Merged
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
37f637e
Add note about logging out of CILogon
GeorgianaElena c562d67
Rephrase the logout processs
GeorgianaElena 49e53f3
Add the missing org from link
GeorgianaElena e983c6d
Clarify logout instructions
choldgraf 7d48028
More details about logging out
GeorgianaElena 2ef8089
Add the login screenshots
GeorgianaElena f965287
Get the figure syntex correctly
GeorgianaElena 436effc
Get list indentation right
GeorgianaElena 96405ba
Cleanup
GeorgianaElena bd6eb48
Add note about clearing cookies
GeorgianaElena 2fa82c1
Got the figure syntex wrong again
GeorgianaElena 0f553b7
A few comments and updates from Chris
choldgraf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -174,9 +174,6 @@ Presently, this involves a few more manual steps than the `auth0` setup describe | |
```{seealso} | ||
See the [CILogon documentation on `Auth0`](https://www.cilogon.org/auth0) for more configuration information. | ||
``` | ||
```{note} | ||
The JupyterHub username will be the email address that users provide when authenticating in CILogon connection. It will not be the CILogon `user_id`! This is because the `USERNAME_KEY` used for the CILogon login is the email address. | ||
``` | ||
|
||
To enable CILogon authentication: | ||
|
||
|
@@ -193,12 +190,6 @@ To enable CILogon authentication: | |
Don't forget to allow login to the test user (`deployment-service-check`), otherwise the hub health check performed during deployment will fail. | ||
``` | ||
|
||
```{note} | ||
If a user wishes to change which account they login with, they will need to go to the [CILogon's logout page](https://cilogon.org/logout) before using the same CILogon Identity Provider with another account. | ||
|
||
However, if another Indentity Provider is to be used, then the extra logout step is no longer required. | ||
``` | ||
|
||
### Example config for CILogon | ||
|
||
The following configuration example shows off how to configure hub admins and allowed users: | ||
|
@@ -232,3 +223,26 @@ config: | |
```{note} | ||
All the users listed under `admin_users` need to match the `username_pattern` expression otherwise they won't be allowed to login! | ||
``` | ||
|
||
### Explanation of CILogon accounts | ||
|
||
There are two details for CILogon accounts worth mentioning: | ||
|
||
- **Institutional connection**. This is the direct connection with CILogon, negotiated by each institution. When a user logs in via CILogon, they first may choose from a variety of institutions (e.g. `UC Berkeley` or `Australia National University`). There is also a fall-back for "Google OAuth". | ||
- **User account**. Within an institution, each user is expected to have their own user account (e.g. `[email protected]`). This is the account that is used to give somebody an ID on their JupyterHub. | ||
|
||
The CILogon connection works by providing access to any user with an account under a particular **institutional connection**, e.g. `*@berkeley.edu`. | ||
|
||
```{note} | ||
Their JupyterHub username will be the **email address** that users provide under the when authenticating with an institutional connection. It will not be the CILogon `user_id`! This is because the `USERNAME_KEY` used for the CILogon login is the email address. | ||
``` | ||
|
||
### Switching user accounts or institutions | ||
|
||
By default, logging in with a particular user account will persist your credentials in future sessions. | ||
This means that you'll automatically re-use the same institutional and user account if you try to log back in. | ||
|
||
**To switch user accounts**, a user can go to the URL endpoing `https://{hub-name}/hub/logout`. | ||
The next time they go to the hub's landing page, they'll be asked to re-authenticate. | ||
|
||
**To switch CILogon institutions**, a user must go to the [CILogon logout page](https://cilogon.org/logout) and click the button to log out of their institutional account. When they try to log back in they should be directed to a page to select institutions once again. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe these are actually the other way around. In practice I've havn't seen switching institution require logging out of CILogon. |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've seen CILogon docs referencing these as IdentityProviders, so I suggest we use the same language as they do, so that if someone checks out the CILogon docs directly it's clear we're talking about the same thing. What do you think>