Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

JupyterHub Users API

User account management.

JupyterHub Users API is one of 11 APIs that JupyterHub publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 3 JSON Schemas.

This API exposes 6 operations across 2 paths. It is described by OpenAPI 3.1.0, at version 5.2.0.

Requests are made against a single base URL, http://localhost:8000/hub/api.

6 operations 2 paths 0 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
5.2.0
Base URL
http://localhost:8000/hub/api
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

JupyterHub Users API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (token). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 9 scopes. By default, every request must be authenticated.

  • token — Token-based authentication. Use the form: Authorization: token

Paths & Operations 6

Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Users 6

User account management.

GET
/users
JupyterHub List users
listUsers 3 params → 200
POST
/users
JupyterHub Create users
createUsers → 201
GET
/users/{name}
JupyterHub Get user
getUser 1 param → 200
POST
/users/{name}
JupyterHub Create user
createUser 1 param → 201
PATCH
/users/{name}
JupyterHub Update user
updateUser 1 param → 200
DELETE
/users/{name}
JupyterHub Delete user
deleteUser 1 param → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyterhub-users-api-openapi.yml Raw ↑

Other APIs JupyterHub publishes across the network.

JupyterHub Activity API
JupyterHub Admin API
JupyterHub Authorizations API
JupyterHub General API
JupyterHub Groups API
JupyterHub OAuth2 API
JupyterHub Proxy API
JupyterHub Servers API
JupyterHub Services API
JupyterHub Tokens API