Couchbase · Capability

Couchbase Sync Gateway Admin REST API — User Management

Couchbase Sync Gateway Admin REST API — User Management. 6 operations. Lead operation: List all users. Self-contained Naftiko capability covering one Couchbase business surface.

Run with Naftiko CouchbaseUser Management

What You Can Do

GET

Listusers — List all users

/v1/{db}/user

POST

Createuser — Create a user

/v1/{db}/user

GET

Getuser — Get user details

/v1/{db}/user/{username}

PUT

Updateuser — Update a user

/v1/{db}/user/{username}

DELETE

Deleteuser — Delete a user

/v1/{db}/user/{username}

POST

Createusersession — Create a session for a user

/v1/{db}/user/{username}/session

MCP Tools

list-all-users

List all users

read-only idempotent

create-user

Create a user

get-user-details

Get user details

read-only idempotent

update-user

Update a user

idempotent

delete-user

Delete a user

idempotent

create-session-user

Create a session for a user

Capability Spec

naftiko: 1.0.0-alpha2
info:
  label: Couchbase Sync Gateway Admin REST API — User Management
  description: 'Couchbase Sync Gateway Admin REST API — User Management. 6 operations. Lead operation: List all users. Self-contained
    Naftiko capability covering one Couchbase business surface.'
  tags:
  - Couchbase
  - User Management
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    COUCHBASE_API_KEY: COUCHBASE_API_KEY
capability:
  consumes:
  - type: http
    namespace: sync-gateway-admin-rest-user-management
    baseUri: https://localhost:4985
    description: Couchbase Sync Gateway Admin REST API — User Management business capability. Self-contained, no shared references.
    resources:
    - name: db-_user
      path: /{db}/_user/
      operations:
      - name: listusers
        method: GET
        description: List all users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createuser
        method: POST
        description: Create a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: db-_user-userName
      path: /{db}/_user/{userName}
      operations:
      - name: getuser
        method: GET
        description: Get user details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateuser
        method: PUT
        description: Update a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteuser
        method: DELETE
        description: Delete a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: db-_user-userName-_session
      path: /{db}/_user/{userName}/_session
      operations:
      - name: createusersession
        method: POST
        description: Create a session for a user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: basic
      username: '{{env.COUCHBASE_USER}}'
      password: '{{env.COUCHBASE_PASS}}'
  exposes:
  - type: rest
    namespace: sync-gateway-admin-rest-user-management-rest
    port: 8080
    description: REST adapter for Couchbase Sync Gateway Admin REST API — User Management. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/{db}/user
      name: db-user
      description: REST surface for db-_user.
      operations:
      - method: GET
        name: listusers
        description: List all users
        call: sync-gateway-admin-rest-user-management.listusers
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuser
        description: Create a user
        call: sync-gateway-admin-rest-user-management.createuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/{db}/user/{username}
      name: db-user-username
      description: REST surface for db-_user-userName.
      operations:
      - method: GET
        name: getuser
        description: Get user details
        call: sync-gateway-admin-rest-user-management.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuser
        description: Update a user
        call: sync-gateway-admin-rest-user-management.updateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: Delete a user
        call: sync-gateway-admin-rest-user-management.deleteuser
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/{db}/user/{username}/session
      name: db-user-username-session
      description: REST surface for db-_user-userName-_session.
      operations:
      - method: POST
        name: createusersession
        description: Create a session for a user
        call: sync-gateway-admin-rest-user-management.createusersession
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sync-gateway-admin-rest-user-management-mcp
    port: 9090
    transport: http
    description: MCP adapter for Couchbase Sync Gateway Admin REST API — User Management. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: list-all-users
      description: List all users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sync-gateway-admin-rest-user-management.listusers
      outputParameters:
      - type: object
        mapping: $.
    - name: create-user
      description: Create a user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sync-gateway-admin-rest-user-management.createuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-user-details
      description: Get user details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sync-gateway-admin-rest-user-management.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: update-user
      description: Update a user
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: sync-gateway-admin-rest-user-management.updateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-user
      description: Delete a user
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sync-gateway-admin-rest-user-management.deleteuser
      outputParameters:
      - type: object
        mapping: $.
    - name: create-session-user
      description: Create a session for a user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sync-gateway-admin-rest-user-management.createusersession
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.