Couchbase

Couchbase User Management API

Endpoints for managing users and their access permissions.

Documentation GitHub OpenAPI

Operations 6

GET /{db}/_user/ List all users #

POST /{db}/_user/ Create a user #

GET /{db}/_user/{userName} Get user details #

PUT /{db}/_user/{userName} Update a user #

DELETE /{db}/_user/{userName} Delete a user #

POST /{db}/_user/{userName}/_session Create a session for a user #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/couchbase-user-management-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Couchbase User Management API
  contact:
    name: Couchbase Support
    url: https://support.couchbase.com
  termsOfService: https://www.couchbase.com/terms-of-use
  version: '1.0'
  description: 'Operations tagged User Management across 2 of this provider''s published API definitions: couchbase-capella-app-services-admin-api-openapi.yml, couchbase-sync-gateway-admin-rest-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{appEndpoint}:4985
  description: Capella App Services Admin endpoint
  variables:
    appEndpoint:
      default: example.apps.cloud.couchbase.com
      description: The App Services admin endpoint URL
- url: https://localhost:4985
  description: Sync Gateway Admin REST API (default port)
security:
- basicAuth: []
tags:
- name: User Management
  description: Endpoints for managing users and their access permissions.
paths:
  /{db}/_user/:
    get:
      operationId: listUsers
      summary: List all users
      description: Returns the list of all users configured for the specified database.
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/db'
      responses:
        '200':
          description: Successful retrieval of user list
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '401':
          description: Unauthorized access
    post:
      operationId: createUser
      summary: Create a user
      description: Creates a new user for the specified database with the given credentials and channel assignments.
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/db'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserConfig'
      responses:
        '201':
          description: User created successfully
        '400':
          description: Invalid user configuration
        '401':
          description: Unauthorized access
        '409':
          description: User already exists
    servers:
    - url: https://{appEndpoint}:4985
      description: Capella App Services Admin endpoint
      variables:
        appEndpoint:
          default: example.apps.cloud.couchbase.com
          description: The App Services admin endpoint URL
  /{db}/_user/{userName}:
    get:
      operationId: getUser
      summary: Get user details
      description: Returns detailed information about a specific user including their roles, channels, and admin channels.
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/db'
      - $ref: '#/components/parameters/userName'
      responses:
        '200':
          description: Successful retrieval of user details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserInfo'
        '401':
          description: Unauthorized access
        '404':
          description: User not found
    put:
      operationId: updateUser
      summary: Update a user
      description: Updates the configuration of an existing user including their password, roles, and channel assignments.
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/db'
      - $ref: '#/components/parameters/userName'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserConfig'
      responses:
        '200':
          description: User updated successfully
        '400':
          description: Invalid user configuration
        '401':
          description: Unauthorized access
        '404':
          description: User not found
    delete:
      operationId: deleteUser
      summary: Delete a user
      description: Deletes the specified user from the database.
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/db'
      - $ref: '#/components/parameters/userName'
      responses:
        '200':
          description: User deleted successfully
        '401':
          description: Unauthorized access
        '404':
          description: User not found
    servers:
    - url: https://{appEndpoint}:4985
      description: Capella App Services Admin endpoint
      variables:
        appEndpoint:
          default: example.apps.cloud.couchbase.com
          description: The App Services admin endpoint URL
  /{db}/_user/{userName}/_session:
    post:
      operationId: createUserSession
      summary: Create a session for a user
      description: Creates a new session for the specified user with an optional expiration time and channel override.
      tags:
      - User Management
      parameters:
      - $ref: '#/components/parameters/db_2'
      - $ref: '#/components/parameters/userName'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                ttl:
                  type: integer
                  description: Session time-to-live in seconds
      responses:
        '200':
          description: Session created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  session_id:
                    type: string
                  expires:
                    type: string
                    format: date-time
                  cookie_name:
                    type: string
        '401':
          description: Unauthorized access
        '404':
          description: User not found
    servers:
    - url: https://localhost:4985
      description: Sync Gateway Admin REST API (default port)
components:
  parameters:
    userName:
      name: userName
      in: path
      required: true
      description: The username
      schema:
        type: string
    db:
      name: db
      in: path
      required: true
      description: The name of the database
      schema:
        type: string
    db_2:
      name: db
      in: path
      required: true
      description: The database name
      schema:
        type: string
  schemas:
    UserInfo:
      type: object
      description: User information
      properties:
        name:
          type: string
          description: Username
        admin_channels:
          type: array
          description: Admin-assigned channels
          items:
            type: string
        admin_roles:
          type: array
          description: Admin-assigned roles
          items:
            type: string
        all_channels:
          type: array
          description: All channels accessible by the user
          items:
            type: string
        roles:
          type: array
          description: All roles assigned to the user
          items:
            type: string
        email:
          type: string
          description: User email address
        disabled:
          type: boolean
          description: Whether the user account is disabled
    UserConfig:
      type: object
      description: User configuration for creation or update
      required:
      - name
      properties:
        name:
          type: string
          description: Username
        password:
          type: string
          description: User password
        admin_channels:
          type: array
          description: Admin-assigned channels
          items:
            type: string
        admin_roles:
          type: array
          description: Admin-assigned roles
          items:
            type: string
        email:
          type: string
          format: email
          description: User email address
        disabled:
          type: boolean
          description: Whether the user account is disabled
    UserInfo_2:
      type: object
      description: User information
      properties:
        name:
          type: string
        admin_channels:
          type: array
          items:
            type: string
        admin_roles:
          type: array
          items:
            type: string
        all_channels:
          type: array
          items:
            type: string
        roles:
          type: array
          items:
            type: string
        email:
          type: string
        disabled:
          type: boolean
    UserConfig_2:
      type: object
      description: User configuration
      required:
      - name
      properties:
        name:
          type: string
          description: Username
        password:
          type: string
          description: User password
        admin_channels:
          type: array
          description: Admin-assigned channels
          items:
            type: string
        admin_roles:
          type: array
          description: Admin-assigned roles
          items:
            type: string
        email:
          type: string
          format: email
          description: User email
        disabled:
          type: boolean
          description: Whether the user is disabled
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication using App Services admin credentials.
x-refined-from:
- couchbase-capella-app-services-admin-api-openapi.yml
- couchbase-sync-gateway-admin-rest-api-openapi.yml