Couchbase · Schema

UserConfig

User configuration for creation or update

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

Properties

Name	Type	Description
name	string	Username
password	string	User password
admin_channels	array	Admin-assigned channels
admin_roles	array	Admin-assigned roles
email	string	User email address
disabled	boolean	Whether the user account is disabled

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserConfig",
  "title": "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"
    }
  }
}