How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Couchbase Authentication API

Endpoints for user authentication and session management.

Couchbase Authentication API is one of 54 APIs that Couchbase 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 and API documentation.

This API exposes 4 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://{appEndpoint}, https://localhost:4984.

4 operations 3 paths 1 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://localhost:8091
Authentication
HTTP Basic, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Couchbase Authentication API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the cookie as SyncGatewaySession (sessionAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using Sync Gateway user credentials.
  • sessionAuth — Session cookie authentication obtained from the session endpoint.

Paths & Operations 4

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

Authentication 4

Endpoints for user authentication and session management.

POST
/{db}/_session
Create a user session
createSession 1 param body → 200401
DELETE
/{db}/_session
Delete current session
deleteSession 1 param → 200401
GET
/{db}/_oidc
Initiate OpenID Connect authentication
oidcAuthenticate 3 params → 302500
GET
/{db}/_oidc_callback
OpenID Connect callback
oidcCallback 3 params → 200401

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is SessionResponse (3 properties). Each schema is shown below with its type and property counts.

SessionResponse
object
Session creation response
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

couchbase-authentication-api-openapi.yml Raw ↑

Other APIs Couchbase publishes across the network.

Couchbase Allowed CIDRs API
Couchbase Analytics Admin API
Couchbase Analytics Configuration API
Couchbase Analytics Library API
Couchbase Analytics Query API
Couchbase Analytics Settings API
Couchbase API Keys API
Couchbase Buckets API
Couchbase Changes API
Couchbase Cluster API
Couchbase Cluster References API
Couchbase Clusters API
Where this information came from

This is an independent, third-party profile of Couchbase Authentication API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.