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

OAuth 2.0 client credentials for partner services.

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

This API exposes 2 JSON Schema definitions.

Tagged areas include Authentication. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 0.

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

1 operations 1 paths 3 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0
Servers
https://auth.calm.com
https://auth-ga.aws-dev.useast1.calm.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Calm Authentication API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • bearerAuth — JWT access token issued by POST /v0/authorize.

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

OAuth 2.0 client credentials for partner services.

POST
/v0/authorize
Authorize Partner Service
authorizePartner body → 200401

Schemas 3

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

Error
object
2 properties
AuthorizeRequest
object
3 properties 3 required
AccessToken
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

calm-com-authentication-api-openapi.yml Raw ↑

Other APIs Calm publishes across the network.

Calm Subscriptions API