From 6ea33fa7cc45938e7d23720cae2ad1e0b2f8b322 Mon Sep 17 00:00:00 2001 From: YuviPanda Date: Tue, 5 Sep 2023 15:21:50 -0700 Subject: [PATCH] Document `oauth_client_id` must start with service- Enforced here: https://github.com/jupyterhub/jupyterhub/blob/7f50a0a7fa8ef4cf589783b9f507b27a4e6b6ba9/jupyterhub/services/service.py#L327 --- examples/external-oauth/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/examples/external-oauth/README.md b/examples/external-oauth/README.md index fc94bb66..77d6ef8d 100644 --- a/examples/external-oauth/README.md +++ b/examples/external-oauth/README.md @@ -60,8 +60,9 @@ The essential pieces for using JupyterHub as an OAuth provider are: "name": "my-service", # the oauth client id of your service # must be unique but isn't private - # can be randomly generated or hand-written - "oauth_client_id": "abc123", + # can be randomly generated or hand-written, but must + # begin with service- + "oauth_client_id": "service-abc123", # the API token and client secret of the service # should be generated securely, # 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: -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 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