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

Calm Authentication API

Obtain a JWT access token via OAuth 2.0 client credentials.

Calm Authentication API is one of 2 APIs that Calm publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against 2 base URLs: https://auth.calm.com, https://auth-ga.aws-dev.useast1.calm.com.

1 operations 1 paths 2 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v0
Base URL
https://auth.calm.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Calm Authentication API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (CalmOAuth2) using the clientCredentials flow, exposing 2 scopes.

  • CalmOAuth2 — OAuth 2.0 client-credentials grant against the Calm auth service.

Paths & Operations 1

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

Authentication 1

Obtain a JWT access token via OAuth 2.0 client credentials.

POST
/v0/authorize
Authenticate partner service
authorize body → 200403

Schemas 2

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

AuthorizeResponse
object
4 properties
AuthorizeRequest
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calm-authentication-api-openapi.yml Raw ↑

Other APIs Calm publishes across the network.

Calm Subscriptions API