Skip to content

Commit

Permalink
examples/service-whoami-flask: Add scope to user role
Browse files Browse the repository at this point in the history
For ordinary users to access the service, they need an appropriate
scope added to the user role.  This adds that role in the
jupyterhub_config.py, as well as a note about this in the README.
It also updates the ouptut that comes form the whoami service.
  • Loading branch information
rschroll committed Jan 18, 2024
1 parent cc9d9e4 commit 8a5fc80
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
13 changes: 9 additions & 4 deletions examples/service-whoami-flask/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,19 @@ After logging in with your local-system credentials, you should see a JSON dump
```json
{
"admin": false,
"last_activity": "2016-05-27T14:05:18.016372",
"groups": [],
"kind": "user",
"name": "queequeg",
"pending": null,
"server": "/user/queequeg"
"scopes": [
"access:services!service=whoami",
"read:users:groups!user=queequeg",
"read:users:name!user=queequeg"
],
"session_id": "a32e59cdd7b445759c58c48e47394a38"
}
```

This relies on the Hub starting the whoami service, via config (see [jupyterhub_config.py](./jupyterhub_config.py)).
This relies on the Hub starting the whoami service, via config (see [jupyterhub_config.py](./jupyterhub_config.py)). For ordinary users to access this service, they need to be given the appropriate scope (again, see [jupyterhub_config.py](./jupyterhub_config.py)).

A similar service could be run externally, by setting the JupyterHub service environment variables:

Expand Down
9 changes: 9 additions & 0 deletions examples/service-whoami-flask/jupyterhub_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@
'environment': {'FLASK_APP': 'whoami-flask.py'},
},
]
c.JupyterHub.load_roles = [
{
'name': 'user',
'scopes': [
'access:services!service=whoami',
'self'
]
}
]

# dummy auth and simple spawner for testing
# any username and password will work
Expand Down

0 comments on commit 8a5fc80

Please sign in to comment.