Couchbase · Schema

RoleInfo

Role information

AnalyticsApp ServicesBackupCapellaCloudDatabaseDBaaSEventingFull-Text SearchGatewayJSONMobileNoSQLReplicationSQL++SyncVector SearchXDCR

Properties

Name Type Description
name string Role name
admin_channels array Admin-assigned channels
all_channels array All channels accessible through this role
View JSON Schema on GitHub

JSON Schema

couchbase-roleinfo-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/RoleInfo",
  "title": "RoleInfo",
  "type": "object",
  "description": "Role information",
  "properties": {
    "name": {
      "type": "string",
      "description": "Role name"
    },
    "admin_channels": {
      "type": "array",
      "description": "Admin-assigned channels",
      "items": {
        "type": "string"
      }
    },
    "all_channels": {
      "type": "array",
      "description": "All channels accessible through this role",
      "items": {
        "type": "string"
      }
    }
  }
}