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

Merge pull request #3142 from snickell/document-external-service-api-tokens-better

Browse Source 
Document external service api_tokens better
This commit is contained in:
Min RK
2020-08-27 09:52:31 +02:00
committed by GitHub
parent 66cb2c0f3e e94da17c3c
commit 10bdca8901
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/reference/services.md
View File

@@ -151,6 +151,8 @@ c.JupyterHub.services = [
{ {
'name': 'my-web-service', 'name': 'my-web-service',
'url': 'https://10.0.1.1:1984', 'url': 'https://10.0.1.1:1984',
# any secret >8 characters, you'll use api_token to
# authenticate api requests to the hub from your service
'api_token': 'super-secret', 'api_token': 'super-secret',
} }
] ]
@@ -331,7 +333,9 @@ and taking note of the following process:
1. retrieve the cookie `jupyterhub-services` from the request. 1. retrieve the cookie `jupyterhub-services` from the request.
2. Make an API request `GET /hub/api/authorizations/cookie/jupyterhub-services/cookie-value`, 2. Make an API request `GET /hub/api/authorizations/cookie/jupyterhub-services/cookie-value`,
where cookie-value is the url-encoded value of the `jupyterhub-services` cookie. where cookie-value is the url-encoded value of the `jupyterhub-services` cookie.
This request must be authenticated with a Hub API token in the `Authorization` header. This request must be authenticated with a Hub API token in the `Authorization` header,
for example using the `api_token` from your [external service's configuration](#externally-managed-services).
For example, with [requests][]: For example, with [requests][]:
```python ```python