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

Jupyter Notebook Authorization API

Token verification and authorization checks.

Jupyter Notebook Authorization API is one of 14 APIs that Jupyter Notebook publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

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

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

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

1 operations 1 paths 2 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
http://localhost:8888/api
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Jupyter Notebook Authorization API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (token). An API key is passed in the query as token (tokenQuery). By default, every request must be authenticated.

  • token — Authentication token configured via KGAUTHTOKEN. Passed as 'token ' in the Authorization header.
  • tokenQuery — Authentication token passed as a query parameter.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Authorization 1

Token verification and authorization checks.

GET
/authorizations/token/{token}
Jupyter Notebook Identify a user by token
checkToken 1 param → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are User (11 properties), Server (9 properties). Each schema is shown below with its type and property counts.

User
object
A JupyterHub user.
11 properties 2 required
Server
object
A user's single-user notebook server.
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jupyter-notebook-authorization-api-openapi.yml Raw ↑

Other APIs Jupyter Notebook publishes across the network.

Jupyter Kernel Messaging Protocol
Jupyter Notebook Config API
Jupyter Notebook Contents API
Jupyter Notebook General API
Jupyter Notebook Groups API
Jupyter Notebook Hub API
Jupyter Notebook Kernels API
Jupyter Notebook Kernelspecs API
Jupyter Notebook Proxy API
Jupyter Notebook Services API
Jupyter Notebook Sessions API
Jupyter Notebook Terminals API