Couchbase Authentication API

openapi: 3.2.0
info:
  title: Couchbase Authentication API
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
  version: '1.0'
  description: 'Operations tagged Authentication across 2 of this provider''s published API definitions: couchbase-capella-app-services-public-api-openapi.yml, couchbase-sync-gateway-public-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{appEndpoint}
  description: Capella App Services endpoint
  variables:
    appEndpoint:
      default: example.apps.cloud.couchbase.com
      description: The App Services endpoint URL
- url: https://localhost:4984
  description: Sync Gateway Public REST API (default port)
security:
- basicAuth: []
- sessionAuth: []
tags:
- name: Authentication
  description: Endpoints for user authentication and session management.
paths:
  /{db}/_session:
    post:
      operationId: createSession
      summary: Create a user session
      description: Authenticates a user and creates a new session. Returns a session cookie that can be used for subsequent requests.
      tags:
      - Authentication
      parameters:
      - $ref: '#/components/parameters/db'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - password
              properties:
                name:
                  type: string
                  description: Username
                password:
                  type: string
                  description: User password
      responses:
        '200':
          description: Session created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionResponse'
        '401':
          description: Invalid credentials
    delete:
      operationId: deleteSession
      summary: Delete current session
      description: Invalidates the current user session.
      tags:
      - Authentication
      parameters:
      - $ref: '#/components/parameters/db'
      responses:
        '200':
          description: Session deleted successfully
        '401':
          description: No active session
    servers:
    - url: https://{appEndpoint}
      description: Capella App Services endpoint
      variables:
        appEndpoint:
          default: example.apps.cloud.couchbase.com
          description: The App Services endpoint URL
  /{db}/_oidc:
    get:
      operationId: oidcAuthenticate
      summary: Initiate OpenID Connect authentication
      description: Initiates the OpenID Connect authentication flow by redirecting the user to the configured identity provider.
      tags:
      - Authentication
      parameters:
      - $ref: '#/components/parameters/db'
      - name: provider
        in: query
        required: false
        description: Name of the OIDC provider
        schema:
          type: string
      - name: offline
        in: query
        required: false
        description: Whether to request a refresh token
        schema:
          type: boolean
      responses:
        '302':
          description: Redirect to identity provider
        '500':
          description: OIDC not configured
    servers:
    - url: https://{appEndpoint}
      description: Capella App Services endpoint
      variables:
        appEndpoint:
          default: example.apps.cloud.couchbase.com
          description: The App Services endpoint URL
  /{db}/_oidc_callback:
    get:
      operationId: oidcCallback
      summary: OpenID Connect callback
      description: Handles the callback from the identity provider after user authentication and creates a Sync Gateway session.
      tags:
      - Authentication
      parameters:
      - $ref: '#/components/parameters/db'
      - name: code
        in: query
        required: true
        description: Authorization code from the identity provider
        schema:
          type: string
      - name: state
        in: query
        required: false
        description: State parameter for CSRF protection
        schema:
          type: string
      responses:
        '200':
          description: Authentication successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionResponse'
        '401':
          description: Authentication failed
    servers:
    - url: https://{appEndpoint}
      description: Capella App Services endpoint
      variables:
        appEndpoint:
          default: example.apps.cloud.couchbase.com
          description: The App Services endpoint URL
components:
  parameters:
    db:
      name: db
      in: path
      required: true
      description: The name of the database (keyspace)
      schema:
        type: string
    db_2:
      name: db
      in: path
      required: true
      description: The database name
      schema:
        type: string
  schemas:
    SessionResponse:
      type: object
      description: Session creation response
      properties:
        session_id:
          type: string
          description: Session identifier
        expires:
          type: string
          format: date-time
          description: Session expiration time
        cookie_name:
          type: string
          description: Name of the session cookie
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using Sync Gateway user credentials.
    sessionAuth:
      type: apiKey
      in: cookie
      name: SyncGatewaySession
      description: Session cookie authentication obtained from the _session endpoint.
x-refined-from:
- couchbase-capella-app-services-public-api-openapi.yml
- couchbase-sync-gateway-public-rest-api-openapi.yml