uni-id-users.schema.json 7.1 KB
Newer Older
雪洛's avatar
雪洛 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
{
	"bsonType": "object",
	"permission":{
		"read":true,
		"update":"doc._id == auth.uid"
	},
	"required": [],
	"properties": {
		"_id": {
			"description": "存储文档 ID(用户 ID),系统自动生成"
		},
		"username": {
			"bsonType": "string",
			"title": "用户名",
			"description": "用户名,不允许重复",
			"trim": "both",
			"permission":{
				"write":false
			}
		},
		"password": {
			"bsonType": "password",
			"title": "密码",
			"description": "密码,加密存储",
			"trim": "both",
			"permission":{
				"write":false
			}
		},
		"password_secret_version": {
			"bsonType": "int",
			"title": "passwordSecret",
			"description": "密码使用的passwordSecret版本",
			"permission":{
				"write":false
			}
		},
		"nickname": {
			"bsonType": "string",
			"title": "昵称",
			"description": "用户昵称",
			"trim": "both"
		},
		"gender": {
			"bsonType": "int",
			"title": "性别",
			"description": "用户性别:0 未知 1 男性 2 女性",
			"defaultValue": 0,
			"enum": [{
					"text": "未知",
					"value": 0
				},
				{
					"text": "男",
					"value": 1
				},
				{
					"text": "女",
					"value": 2
				}
			]
		},
		"status": {
			"bsonType": "int",
			"description": "用户状态:0 正常 1 禁用 2 审核中 3 审核拒绝",
			"title": "用户状态",
			"defaultValue": 0,
			"permission":{
				"write":false
			},
			"enum": [{
					"text": "正常",
					"value": 0
				},
				{
					"text": "禁用",
					"value": 1
				},
				{
					"text": "审核中",
					"value": 2
				},
				{
					"text": "审核拒绝",
					"value": 3
				}
			]
		},
		"mobile": {
			"bsonType": "string",
			"title": "手机号码",
			"description": "手机号码",
			"pattern": "^\\+?[0-9-]{3,20}$",
			"trim": "both",
			"permission":{
				"write":false
			}
		},
		"mobile_confirmed": {
			"bsonType": "int",
			"description": "手机号验证状态:0 未验证 1 已验证",
			"title": "手机号验证状态",
			"defaultValue": 0,
			"enum": [{
					"text": "未验证",
					"value": 0
				},
				{
					"text": "已验证",
					"value": 1
				}
			],
			"permission":{
				"write":false
			}
		},
		"email": {
			"bsonType": "string",
			"format": "email",
			"title": "邮箱",
			"description": "邮箱地址",
			"trim": "both",
			"permission":{
				"write":false
			}
		},
		"email_confirmed": {
			"bsonType": "int",
			"description": "邮箱验证状态:0 未验证 1 已验证",
			"title": "邮箱验证状态",
			"defaultValue": 0,
			"enum": [{
					"text": "未验证",
					"value": 0
				},
				{
					"text": "已验证",
					"value": 1
				}
			],
			"permission":{
				"write":false
			}
		},
		"avatar": {
			"bsonType": "string",
			"title": "头像地址",
			"description": "头像地址",
			"trim": "both"
		},
		"avatar_file": {
			"bsonType": "file",
			"title": "头像文件",
			"description": "用file类型方便使用uni-file-picker组件"
		},
		"department_id": {
			"bsonType": "array",
			"description": "部门ID",
			"permission":{
				"write":false
			},
			"title": "部门",
			"enumType": "tree",
			"enum": {
				"collection": "opendb-department",
				"orderby": "name asc",
				"field": "_id as value, name as text"
			}
		},
		"role": {
			"bsonType": "array",
			"title": "角色",
			"description": "用户角色",
			"enum": {
				"collection": "uni-id-roles",
				"field": "role_id as value, role_name as text"
			},
			"foreignKey": "uni-id-roles.role_id",
			"permission": {
				"write": false
			}
		},
		"wx_unionid": {
			"bsonType": "string",
			"description": "微信unionid",
			"permission":{
				"write":false
			}
		},
		"wx_openid": {
			"bsonType": "object",
			"description": "微信各个平台openid",
			"properties": {
				"app-plus": {
					"bsonType": "string",
					"description": "app平台微信openid"
				},
				"mp-weixin": {
					"bsonType": "string",
					"description": "微信小程序平台openid"
				}
			},
			"permission":{
				"write":false
			}
		},
		"ali_openid": {
			"bsonType": "string",
			"description": "支付宝平台openid",
			"permission":{
				"write":false
			}
		},
		"apple_openid": {
			"bsonType": "string",
			"description": "苹果登录openid",
			"permission":{
				"write":false
			}
		},
		"comment": {
			"bsonType": "string",
			"title": "备注",
			"description": "备注",
			"trim": "both",
			"permission":{
				"write":false
			}
		},
		"realname_auth": {
			"bsonType": "object",
			"description": "实名认证信息",
			"required": [
				"type",
				"auth_status"
			],
			"permission":{
				"write":false
			},
			"properties": {
				"type": {
					"bsonType": "int",
					"minimum": 0,
					"maximum": 1,
					"description": "用户类型:0 个人用户 1 企业用户"
				},
				"auth_status": {
					"bsonType": "int",
					"minimum": 0,
					"maximum": 3,
					"description": "认证状态:0 未认证 1 等待认证 2 认证通过 3 认证失败"
				},
				"auth_date": {
					"bsonType": "timestamp",
					"description": "认证通过时间"
				},
				"real_name": {
					"bsonType": "string",
					"description": "真实姓名/企业名称"
				},
				"identity": {
					"bsonType": "string",
					"description": "身份证号码/营业执照号码"
				},
				"id_card_front": {
					"bsonType": "string",
					"description": "身份证正面照 URL"
				},
				"id_card_back": {
					"bsonType": "string",
					"description": "身份证反面照 URL"
				},
				"in_hand": {
					"bsonType": "string",
					"description": "手持身份证照片 URL"
				},
				"license": {
					"bsonType": "string",
					"description": "营业执照 URL"
				},
				"contact_person": {
					"bsonType": "string",
					"description": "联系人姓名"
				},
				"contact_mobile": {
					"bsonType": "string",
					"description": "联系人手机号码"
				},
				"contact_email": {
					"bsonType": "string",
					"description": "联系人邮箱"
				}
			}
		},
		"score": {
			"bsonType": "int",
			"description": "用户积分,积分变更记录可参考:uni-id-scores表定义",
			"permission":{
				"write":false
			}
		},
		"register_date": {
			"bsonType": "timestamp",
			"description": "注册时间",
			"forceDefaultValue": {
				"$env": "now"
			},
			"permission":{
				"write":false
			}
		},
		"register_ip": {
			"bsonType": "string",
			"description": "注册时 IP 地址",
			"forceDefaultValue": {
				"$env": "clientIP"
			},
			"permission":{
				"write":false
			}
		},
		"last_login_date": {
			"bsonType": "timestamp",
			"description": "最后登录时间",
			"permission":{
				"write":false
			}
		},
		"last_login_ip": {
			"bsonType": "string",
			"description": "最后登录时 IP 地址",
			"permission":{
				"write":false
			}
		},
		"token": {
			"bsonType": "array",
			"description": "用户token",
			"permission":{
				"write":false
			}
		},
		"inviter_uid": {
			"bsonType": "array",
			"description": "用户全部上级邀请者",
			"trim": "both",
			"permission":{
				"write":false
			}
		},
		"invite_time": {
			"bsonType": "timestamp",
			"description": "受邀时间",
			"permission":{
				"write":false
			}
		},
		"my_invite_code": {
			"bsonType": "string",
			"description": "用户自身邀请码",
			"permission":{
				"write":false
			}
		}
	}
}