hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-07 01:54:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document oauth_client_id must start with service-

Browse Source 
Enforced here: 7f50a0a7fa/jupyterhub/services/service.py (L327)
This commit is contained in:
YuviPanda
2023-09-05 15:21:50 -07:00
parent 7f50a0a7fa
commit 6ea33fa7cc
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
examples/external-oauth/README.md
View File

@@ -60,8 +60,9 @@ The essential pieces for using JupyterHub as an OAuth provider are:
"name": "my-service", "name": "my-service",
# the oauth client id of your service # the oauth client id of your service
# must be unique but isn't private # must be unique but isn't private
# can be randomly generated or hand-written # can be randomly generated or hand-written, but must
"oauth_client_id": "abc123", # begin with service-
"oauth_client_id": "service-abc123",
# the API token and client secret of the service # the API token and client secret of the service
# should be generated securely, # should be generated securely,
# e.g. via `openssl rand -hex 32` # e.g. via `openssl rand -hex 32`
@@ -77,7 +78,7 @@ The essential pieces for using JupyterHub as an OAuth provider are:
The relevant OAuth URLs and keys for using JupyterHub as an OAuth provider are: The relevant OAuth URLs and keys for using JupyterHub as an OAuth provider are:
1. the client_id, used in oauth requests 1. the client_id, used in oauth requests. This must begin with the characters `service-`
2. the api token registered with jupyterhub is the client_secret for oauth requests 2. the api token registered with jupyterhub is the client_secret for oauth requests
3. oauth url of the Hub, which is "/hub/api/oauth2/authorize", e.g. `https://myhub.horse/hub/api/oauth2/authorize` 3. oauth url of the Hub, which is "/hub/api/oauth2/authorize", e.g. `https://myhub.horse/hub/api/oauth2/authorize`
4. a redirect handler to receive the authenticated response 4. a redirect handler to receive the authenticated response