uni-id-users.schema.json 8.9 KB
Newer Older
1
{
雪洛's avatar
雪洛 已提交
2
	"bsonType": "object",
3 4
	"permission": {
		"update": "doc._id == auth.uid",
5
		"read": true
6 7 8 9 10 11 12 13 14
	},
	"properties": {
		"_id": {
			"description": "存储文档 ID(用户 ID),系统自动生成"
		},
		"ali_openid": {
			"bsonType": "string",
			"description": "支付宝平台openid",
			"permission": {
15 16
				"write": false,
				"read": "doc._id == auth.uid"
17 18 19 20 21 22
			}
		},
		"apple_openid": {
			"bsonType": "string",
			"description": "苹果登录openid",
			"permission": {
23 24
				"write": false,
				"read": "doc._id == auth.uid"
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
			}
		},
		"avatar": {
			"bsonType": "string",
			"description": "头像地址",
			"title": "头像地址",
			"trim": "both"
		},
		"avatar_file": {
			"bsonType": "file",
			"description": "用file类型方便使用uni-file-picker组件",
			"title": "头像文件"
		},
		"comment": {
			"bsonType": "string",
			"description": "备注",
			"title": "备注",
雪洛's avatar
雪洛 已提交
42
			"trim": "both",
43
			"permission": {
44 45
				"write": false,
				"read": false
46 47 48 49 50 51 52
			}
		},
		"dcloud_appid": {
			"bsonType": "array",
			"description": "允许登录的客户端的appid列表",
			"foreignKey": "opendb-app-list.appid",
			"permission": {
53 54
				"write": false,
				"read": "doc._id == auth.uid"
55 56 57 58 59 60 61 62 63 64 65 66 67
			}
		},
		"department_id": {
			"bsonType": "array",
			"description": "部门ID",
			"enum": {
				"collection": "opendb-department",
				"field": "_id as value, name as text",
				"orderby": "name asc"
			},
			"enumType": "tree",
			"title": "部门",
			"permission": {
68 69
				"write": false,
				"read": "doc._id == auth.uid"
70 71 72 73 74 75 76
			}
		},
		"email": {
			"bsonType": "string",
			"description": "邮箱地址",
			"format": "email",
			"title": "邮箱",
雪洛's avatar
雪洛 已提交
77
			"trim": "both",
78
			"permission": {
79 80
				"write": false,
				"read": "doc._id == auth.uid"
雪洛's avatar
雪洛 已提交
81
			}
82 83 84
		},
		"email_confirmed": {
			"bsonType": "int",
雪洛's avatar
雪洛 已提交
85
			"defaultValue": 0,
86 87 88 89 90 91 92 93 94
			"description": "邮箱验证状态:0 未验证 1 已验证",
			"enum": [{
					"text": "未验证",
					"value": 0
				},
				{
					"text": "已验证",
					"value": 1
				}
雪洛's avatar
雪洛 已提交
95
			],
96 97
			"title": "邮箱验证状态",
			"permission": {
98 99
				"write": false,
				"read": "doc._id == auth.uid"
100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
			}
		},
		"gender": {
			"bsonType": "int",
			"defaultValue": 0,
			"description": "用户性别:0 未知 1 男性 2 女性",
			"enum": [{
					"text": "未知",
					"value": 0
				},
				{
					"text": "男",
					"value": 1
				},
				{
					"text": "女",
					"value": 2
				}
雪洛's avatar
雪洛 已提交
118
			],
119 120
			"title": "性别",
			"permission": {
121 122
				"write": false,
				"read": "doc._id == auth.uid"
123 124 125 126 127 128
			}
		},
		"invite_time": {
			"bsonType": "timestamp",
			"description": "受邀时间",
			"permission": {
129 130
				"write": false,
				"read": "doc._id == auth.uid"
131 132 133 134 135
			}
		},
		"inviter_uid": {
			"bsonType": "array",
			"description": "用户全部上级邀请者",
雪洛's avatar
雪洛 已提交
136
			"trim": "both",
137
			"permission": {
138 139
				"write": false,
				"read": "doc._id == auth.uid"
140 141 142 143
			}
		},
		"last_login_date": {
			"bsonType": "timestamp",
雪洛's avatar
雪洛 已提交
144
			"description": "最后登录时间",
145
			"permission": {
146 147
				"write": false,
				"read": "doc._id == auth.uid"
148 149 150 151
			}
		},
		"last_login_ip": {
			"bsonType": "string",
雪洛's avatar
雪洛 已提交
152
			"description": "最后登录时 IP 地址",
153
			"permission": {
154 155
				"write": false,
				"read": "doc._id == auth.uid"
156 157 158 159 160 161 162
			}
		},
		"mobile": {
			"bsonType": "string",
			"description": "手机号码",
			"pattern": "^\\+?[0-9-]{3,20}$",
			"title": "手机号码",
雪洛's avatar
雪洛 已提交
163
			"trim": "both",
164
			"permission": {
165 166
				"write": false,
				"read": "doc._id == auth.uid"
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
			}
		},
		"mobile_confirmed": {
			"bsonType": "int",
			"defaultValue": 0,
			"description": "手机号验证状态:0 未验证 1 已验证",
			"enum": [{
					"text": "未验证",
					"value": 0
				},
				{
					"text": "已验证",
					"value": 1
				}
			],
			"title": "手机号验证状态",
			"permission": {
184 185
				"write": false,
				"read": "doc._id == auth.uid"
186 187 188 189
			}
		},
		"my_invite_code": {
			"bsonType": "string",
雪洛's avatar
雪洛 已提交
190
			"description": "用户自身邀请码",
191
			"permission": {
192 193
				"write": false,
				"read": "doc._id == auth.uid"
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
			}
		},
		"nickname": {
			"bsonType": "string",
			"description": "用户昵称",
			"title": "昵称",
			"trim": "both"
		},
		"password": {
			"bsonType": "password",
			"description": "密码,加密存储",
			"title": "密码",
			"trim": "both",
			"permission": {
				"write": false,
				"read": false
			}
		},
		"password_secret_version": {
			"bsonType": "int",
			"description": "密码使用的passwordSecret版本",
			"title": "passwordSecret",
			"permission": {
				"write": false,
				"read": false
			}
		},
		"realname_auth": {
			"bsonType": "object",
			"description": "实名认证信息",
			"permission": {
225 226
				"write": false,
				"read": "doc._id == auth.uid"
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
			},
			"properties": {
				"auth_date": {
					"bsonType": "timestamp",
					"description": "认证通过时间"
				},
				"auth_status": {
					"bsonType": "int",
					"description": "认证状态:0 未认证 1 等待认证 2 认证通过 3 认证失败",
					"maximum": 3,
					"minimum": 0
				},
				"contact_email": {
					"bsonType": "string",
					"description": "联系人邮箱"
				},
				"contact_mobile": {
					"bsonType": "string",
					"description": "联系人手机号码"
				},
				"contact_person": {
					"bsonType": "string",
					"description": "联系人姓名"
				},
				"id_card_back": {
					"bsonType": "string",
					"description": "身份证反面照 URL"
				},
				"id_card_front": {
					"bsonType": "string",
					"description": "身份证正面照 URL"
				},
				"identity": {
					"bsonType": "string",
					"description": "身份证号码/营业执照号码"
				},
				"in_hand": {
					"bsonType": "string",
					"description": "手持身份证照片 URL"
				},
				"license": {
					"bsonType": "string",
					"description": "营业执照 URL"
				},
				"real_name": {
					"bsonType": "string",
					"description": "真实姓名/企业名称"
				},
				"type": {
					"bsonType": "int",
					"description": "用户类型:0 个人用户 1 企业用户",
					"maximum": 1,
					"minimum": 0
				}
			},
			"required": [
				"type",
				"auth_status"
			]
		},
		"register_date": {
			"bsonType": "timestamp",
			"description": "注册时间",
			"forceDefaultValue": {
291 292
				"$env": "now",
				"read": "doc._id == auth.uid"
293 294 295 296 297 298
			}
		},
		"register_ip": {
			"bsonType": "string",
			"description": "注册时 IP 地址",
			"forceDefaultValue": {
299 300
				"$env": "clientIP",
				"read": "doc._id == auth.uid"
301 302 303 304 305 306 307 308 309 310 311
			}
		},
		"role": {
			"bsonType": "array",
			"description": "用户角色",
			"enum": {
				"collection": "uni-id-roles",
				"field": "role_id as value, role_name as text"
			},
			"foreignKey": "uni-id-roles.role_id",
			"permission": {
312 313
				"write": false,
				"read": "doc._id == auth.uid"
314 315 316 317 318 319 320
			},
			"title": "角色"
		},
		"score": {
			"bsonType": "int",
			"description": "用户积分,积分变更记录可参考:uni-id-scores表定义",
			"permission": {
321 322
				"write": false,
				"read": "doc._id == auth.uid"
323 324 325 326 327 328 329
			}
		},
		"status": {
			"bsonType": "int",
			"defaultValue": 0,
			"description": "用户状态:0 正常 1 禁用 2 审核中 3 审核拒绝",
			"permission": {
330 331
				"write": false,
				"read": "doc._id == auth.uid"
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353
			},
			"enum": [{
					"text": "正常",
					"value": 0
				},
				{
					"text": "禁用",
					"value": 1
				},
				{
					"text": "审核中",
					"value": 2
				},
				{
					"text": "审核拒绝",
					"value": 3
				}
			],
			"title": "用户状态"
		},
		"token": {
			"bsonType": "array",
354 355 356 357
			"description": "用户token",
			"permission": {
				"read": "doc._id == auth.uid"
			}
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
		},
		"username": {
			"bsonType": "string",
			"description": "用户名,不允许重复",
			"title": "用户名",
			"trim": "both",
			"permission": {
				"write": false
			}
		},
		"wx_openid": {
			"bsonType": "object",
			"description": "微信各个平台openid",
			"properties": {
				"app": {
					"bsonType": "string",
					"description": "app平台微信openid"
				},
				"mp": {
					"bsonType": "string",
					"description": "微信小程序平台openid"
				},
				"h5": {
					"bsonType": "string",
					"description": "微信公众号登录openid"
				},
				"web": {
					"bsonType": "string",
					"description": "PC页面扫码登录openid"
				}
			},
			"permission": {
390 391
				"write": false,
				"read": "doc._id == auth.uid"
392 393 394 395 396 397
			}
		},
		"wx_unionid": {
			"bsonType": "string",
			"description": "微信unionid",
			"permission": {
398 399
				"write": false,
				"read": "doc._id == auth.uid"
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
			}
		},
		"qq_openid": {
			"bsonType": "object",
			"description": "QQ各个平台openid",
			"properties": {
				"app": {
					"bsonType": "string",
					"description": "app平台QQ openid"
				},
				"mp": {
					"bsonType": "string",
					"description": "QQ小程序平台openid"
				}
			},
			"permission": {
416 417
				"write": false,
				"read": "doc._id == auth.uid"
418 419 420 421 422 423
			}
		},
		"qq_unionid": {
			"bsonType": "string",
			"description": "QQ unionid",
			"permission": {
424 425
				"write": false,
				"read": "doc._id == auth.uid"
426 427 428 429
			}
		}
	},
	"required": []
雪洛's avatar
雪洛 已提交
430
}