Couchbase · Schema

DatabaseCredentialCreateRequest

Request to create database credentials

AnalyticsApp ServicesBackupCapellaCloudDatabaseDatabase-as-a-ServiceEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name	Type	Description
name	string	Credential name
password	string	Credential password (must meet complexity requirements)
access	array	Access privileges to assign

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DatabaseCredentialCreateRequest",
  "title": "DatabaseCredentialCreateRequest",
  "type": "object",
  "description": "Request to create database credentials",
  "required": [
    "name",
    "password",
    "access"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Credential name"
    },
    "password": {
      "type": "string",
      "description": "Credential password (must meet complexity requirements)"
    },
    "access": {
      "type": "array",
      "description": "Access privileges to assign",
      "items": {
        "type": "object",
        "properties": {
          "privileges": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "data_reader",
                "data_writer"
              ]
            }
          },
          "resources": {
            "type": "object",
            "properties": {
              "buckets": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}