Couchbase · Schema

DatabaseCredential

Database access credential

AnalyticsApp ServicesBackupCapellaCloudDatabaseDBaaSEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name Type Description
id string Credential UUID
name string Credential name
access array Access privileges
audit object
View JSON Schema on GitHub

JSON Schema

couchbase-databasecredential-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DatabaseCredential",
  "title": "DatabaseCredential",
  "type": "object",
  "description": "Database access credential",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "Credential UUID"
    },
    "name": {
      "type": "string",
      "description": "Credential name"
    },
    "access": {
      "type": "array",
      "description": "Access privileges",
      "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"
                    },
                    "scopes": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "name": {
                            "type": "string"
                          },
                          "collections": {
                            "type": "array",
                            "items": {
                              "type": "string"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "audit": {
      "$ref": "#/components/schemas/AuditInfo"
    }
  }
}