JupyterHub · OAuth Scopes

JupyterHub OAuth Scopes

OAuth 2.0 derived

JupyterHub publishes 9 OAuth 2.0 scopes via the authorizationCode flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the JupyterHub API on a user’s behalf.

Tokens are issued from /hub/api/oauth2/token.

This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.

AuthenticationData ScienceEducationHubMulti-UserNotebooksOAuth2Python
Scopes: 9 Flows: authorizationCode Method: derived

OAuth endpoints

Authorization URL
/hub/api/oauth2/authorize
Token URL
/hub/api/oauth2/token
Flows
authorizationCode

Scopes (9)

ScopeDescriptionFlows
admin:groups Administer groups. authorizationCode
admin:servers Administer single-user servers. authorizationCode
admin:users Administer users. authorizationCode
list:users List users. authorizationCode
proxy Manage the proxy. authorizationCode
read:groups Read group information. authorizationCode
read:services Read service information. authorizationCode
read:users Read user information. authorizationCode
self Access to the current user. authorizationCode

Source

OAuth Scopes

jupyterhub-scopes.yml Raw ↑
generated: '2026-07-11'
method: derived
source: openapi/jupyterhub-rest-api-openapi.yml
schemes:
- name: oauth2
  source: openapi/jupyterhub-rest-api-openapi.yml
  flows:
  - flow: authorizationCode
    authorizationUrl: /hub/api/oauth2/authorize
    tokenUrl: /hub/api/oauth2/token
scopes:
- scope: admin:groups
  description: Administer groups.
  flows:
  - authorizationCode
  sources:
  - openapi/jupyterhub-rest-api-openapi.yml
- scope: admin:servers
  description: Administer single-user servers.
  flows:
  - authorizationCode
  sources:
  - openapi/jupyterhub-rest-api-openapi.yml
- scope: admin:users
  description: Administer users.
  flows:
  - authorizationCode
  sources:
  - openapi/jupyterhub-rest-api-openapi.yml
- scope: list:users
  description: List users.
  flows:
  - authorizationCode
  sources:
  - openapi/jupyterhub-rest-api-openapi.yml
- scope: proxy
  description: Manage the proxy.
  flows:
  - authorizationCode
  sources:
  - openapi/jupyterhub-rest-api-openapi.yml
- scope: read:groups
  description: Read group information.
  flows:
  - authorizationCode
  sources:
  - openapi/jupyterhub-rest-api-openapi.yml
- scope: read:services
  description: Read service information.
  flows:
  - authorizationCode
  sources:
  - openapi/jupyterhub-rest-api-openapi.yml
- scope: read:users
  description: Read user information.
  flows:
  - authorizationCode
  sources:
  - openapi/jupyterhub-rest-api-openapi.yml
- scope: self
  description: Access to the current user.
  flows:
  - authorizationCode
  sources:
  - openapi/jupyterhub-rest-api-openapi.yml