Model users
Permissions
| User Group | Create? | Read? | Update? | Delete? |
|---|
| admin | x | x | x | x |
| owner | | x | x | |
| user | | x | | |
| member | | x | | |
| api | | x | | |
Fields
| Name | Type | Link | Maps To | Default | Indexed? | Unique? | Required? |
|---|
| __v | Number | | | | | | |
| _deleted | Boolean | | | false | x | | |
| _id | ObjectID | | | [Function] | | | |
| _owner_id | ObjectID | User | _owner | | x | | |
| _updated_by_id | ObjectID | User | _updated_by | | x | | |
| about | String | | | | | | |
| admin | Boolean | | | | | | |
| card | String | | | | | | |
| checked_in | Boolean | | | false | x | | |
| checkin_id | ObjectID | Checkin | | | | | |
| clay_access_group_ids | Array of ObjectID | | | [Function] | | | |
| clay_id | String | | | | | | |
| claytag_id | ObjectID | Claytag | | | | | |
| createdAt | Date | | | | | | |
| date_created | Date | | | [Function] | | | |
| department | String | | | | | | |
| email | String | | | | x | x | |
| emails | Array of String | | | [Function] | | | |
| facebook | Mixed | | | | | | |
| first_login | Boolean | | | true | | | |
| google | Mixed | | | | | | |
| hidden | Boolean | | | false | x | | |
| id_number | String | | | | | | |
| img | String | | | /avatars/grey_avatar_1.png | | | |
| is_parking_user | Boolean | | | false | | | |
| last_checkin | Date | | | | | | |
| last_checkin_location_id | ObjectID | Location | last_checkin_location | | | | |
| last_login | Date | | | | | | |
| linkedin | Mixed | | | | | | |
| location_id | ObjectID | Location | | | x | | x |
| membership_id | ObjectID | Membership | | | x | | |
| mobile | String | | | | | | |
| name | String | | | | x | | x |
| newsletter | Boolean | | | | | | |
| offboard_date | Date | | | | | | |
| onboard_date | Date | | | | | | |
| onboarded | Boolean | | | false | | | |
| organisation_id | ObjectID | Organisation | | | x | | |
| papercut_username | String | | | | | | |
| password | String | | | | | | |
| pending_parking_charge | Boolean | | | false | | | |
| pin | String | | | | | | |
| position | String | | | | | | |
| presence | Boolean | | | true | x | | |
| radius_id | Number | | | | | | |
| referal_method | String | | | | | | |
| referee | String | | | | | | |
| skype | String | | | | | | |
| slack_name | String | | | | | | |
| space_id | ObjectID | Space | | | x | | |
| start_date | Date | | | [Function] | | | |
| status | String | | | inactive | x | | |
| tag_id | Array of ObjectID | | | [Function] | | | |
| temp_hash | String | | | | | | |
| timezone | String | | | | | | |
| twitter | Mixed | | | | | | |
| unikey_pin | String | | | | | | |
| updatedAt | Date | | | | | | |
| url | String | | | | | | |
| urlid | String | | | | x | | |
| user_printing | Boolean | | | false | | | |
| wifi_password | String | | | | | | |
| wifi_username | String | | | | | | |
| xero_id | String | | | | | | |
Field Details
__v
{
"path": "__v",
"instance": "Number",
"options": {},
"validators": []
}_deleted
{
"path": "_deleted",
"instance": "Boolean",
"options": {
"default": false,
"index": true
},
"validators": [],
"defaultValue": false
}_id
{
"path": "_id",
"instance": "ObjectID",
"options": {
"auto": true,
"type": "ObjectId"
},
"validators": [],
"defaultValue": "[Function]"
}_owner_id
{
"path": "_owner_id",
"instance": "ObjectID",
"options": {
"link": "User",
"map_to": "_owner",
"index": true
},
"validators": []
}_updated_by_id
{
"path": "_updated_by_id",
"instance": "ObjectID",
"options": {
"link": "User",
"map_to": "_updated_by",
"index": true
},
"validators": []
}about
{
"path": "about",
"instance": "String",
"options": {},
"validators": []
}admin
{
"path": "admin",
"instance": "Boolean",
"options": {},
"validators": []
}card
{
"path": "card",
"instance": "String",
"options": {},
"validators": []
}checked_in
{
"path": "checked_in",
"instance": "Boolean",
"options": {
"default": false,
"index": true
},
"validators": [],
"defaultValue": false
}checkin_id
{
"path": "checkin_id",
"instance": "ObjectID",
"options": {
"link": "Checkin"
},
"validators": []
}clay_access_group_ids
{
"path": "clay_access_group_ids",
"instance": "Array",
"options": {
"type": [
{
"link": "Clayaccessgroup"
}
]
},
"validators": [],
"defaultValue": "[Function]",
"arrayType": "ObjectID"
}clay_id
{
"path": "clay_id",
"instance": "String",
"options": {},
"validators": []
}claytag_id
{
"path": "claytag_id",
"instance": "ObjectID",
"options": {
"link": "Claytag"
},
"validators": []
}createdAt
{
"path": "createdAt",
"instance": "Date",
"options": {
"immutable": true
},
"validators": []
}date_created
{
"path": "date_created",
"instance": "Date",
"options": {},
"validators": [],
"defaultValue": "[Function]"
}department
{
"path": "department",
"instance": "String",
"options": {},
"validators": []
}email
{
"path": "email",
"instance": "String",
"options": {
"unique": true,
"index": true,
"validate": [
null,
"Please use a valid email address"
]
},
"validators": [
{
"message": "Please use a valid email address"
}
]
}Validators
- : Please use a valid email address
emails
{
"path": "emails",
"instance": "Array",
"options": {
"type": [
{
"validate": [
null,
"Please use a valid email address"
]
}
]
},
"validators": [],
"defaultValue": "[Function]",
"arrayType": "String"
}facebook
{
"path": "facebook",
"instance": "Mixed",
"options": {},
"validators": []
}first_login
{
"path": "first_login",
"instance": "Boolean",
"options": {
"default": true
},
"validators": [],
"defaultValue": true
}google
{
"path": "google",
"instance": "Mixed",
"options": {},
"validators": []
}hidden
{
"path": "hidden",
"instance": "Boolean",
"options": {
"default": false,
"index": true
},
"validators": [],
"defaultValue": false
}id_number
{
"path": "id_number",
"instance": "String",
"options": {},
"validators": []
}img
{
"path": "img",
"instance": "String",
"options": {
"default": "/avatars/grey_avatar_1.png"
},
"validators": [],
"defaultValue": "/avatars/grey_avatar_1.png"
}is_parking_user
{
"path": "is_parking_user",
"instance": "Boolean",
"options": {
"default": false
},
"validators": [],
"defaultValue": false
}last_checkin
{
"path": "last_checkin",
"instance": "Date",
"options": {},
"validators": []
}last_checkin_location_id
{
"path": "last_checkin_location_id",
"instance": "ObjectID",
"options": {
"link": "Location",
"map_to": "last_checkin_location"
},
"validators": []
}last_login
{
"path": "last_login",
"instance": "Date",
"options": {},
"validators": []
}linkedin
{
"path": "linkedin",
"instance": "Mixed",
"options": {},
"validators": []
}location_id
{
"path": "location_id",
"instance": "ObjectID",
"options": {
"link": "Location",
"required": true,
"index": true
},
"validators": [
{
"message": "Path `{PATH}` is required."
}
],
"isRequired": true
}Validators
- : Path `{PATH}` is required.
membership_id
{
"path": "membership_id",
"instance": "ObjectID",
"options": {
"link": "Membership",
"index": true
},
"validators": []
}mobile
{
"path": "mobile",
"instance": "String",
"options": {},
"validators": []
}name
{
"path": "name",
"instance": "String",
"options": {
"required": true,
"index": true
},
"validators": [
{
"message": "Path `{PATH}` is required."
},
{
"message": "Name cannot be empty"
}
],
"isRequired": true
}Validators
- : Path `{PATH}` is required.
- : Name cannot be empty
newsletter
{
"path": "newsletter",
"instance": "Boolean",
"options": {},
"validators": []
}offboard_date
{
"path": "offboard_date",
"instance": "Date",
"options": {},
"validators": []
}onboard_date
{
"path": "onboard_date",
"instance": "Date",
"options": {},
"validators": []
}onboarded
{
"path": "onboarded",
"instance": "Boolean",
"options": {
"default": false
},
"validators": [],
"defaultValue": false
}organisation_id
{
"path": "organisation_id",
"instance": "ObjectID",
"options": {
"link": "Organisation",
"index": true
},
"validators": []
}papercut_username
{
"path": "papercut_username",
"instance": "String",
"options": {},
"validators": []
}password
{
"path": "password",
"instance": "String",
"options": {},
"validators": []
}pending_parking_charge
{
"path": "pending_parking_charge",
"instance": "Boolean",
"options": {
"default": false
},
"validators": [],
"defaultValue": false
}pin
{
"path": "pin",
"instance": "String",
"options": {},
"validators": []
}position
{
"path": "position",
"instance": "String",
"options": {},
"validators": []
}presence
{
"path": "presence",
"instance": "Boolean",
"options": {
"default": true,
"index": true
},
"validators": [],
"defaultValue": true
}radius_id
{
"path": "radius_id",
"instance": "Number",
"options": {},
"validators": []
}referal_method
{
"path": "referal_method",
"instance": "String",
"options": {},
"validators": []
}referee
{
"path": "referee",
"instance": "String",
"options": {},
"validators": []
}skype
{
"path": "skype",
"instance": "String",
"options": {},
"validators": []
}slack_name
{
"path": "slack_name",
"instance": "String",
"options": {},
"validators": []
}space_id
{
"path": "space_id",
"instance": "ObjectID",
"options": {
"link": "Space",
"index": true
},
"validators": []
}start_date
{
"path": "start_date",
"instance": "Date",
"options": {},
"validators": [],
"defaultValue": "[Function]"
}status
{
"path": "status",
"instance": "String",
"options": {
"validate": {},
"index": true,
"default": "inactive"
},
"validators": [
{
"message": "Validator failed for path `{PATH}` with value `{VALUE}`"
}
],
"defaultValue": "inactive"
}Validators
- : Validator failed for path `{PATH}` with value `{VALUE}`
tag_id
{
"path": "tag_id",
"instance": "Array",
"options": {
"type": [
{
"link": "Tag"
}
]
},
"validators": [],
"defaultValue": "[Function]",
"arrayType": "ObjectID"
}temp_hash
{
"path": "temp_hash",
"instance": "String",
"options": {},
"validators": []
}timezone
{
"path": "timezone",
"instance": "String",
"options": {},
"validators": []
}twitter
{
"path": "twitter",
"instance": "Mixed",
"options": {},
"validators": []
}unikey_pin
{
"path": "unikey_pin",
"instance": "String",
"options": {},
"validators": []
}updatedAt
{
"path": "updatedAt",
"instance": "Date",
"options": {},
"validators": []
}url
{
"path": "url",
"instance": "String",
"options": {},
"validators": []
}urlid
{
"path": "urlid",
"instance": "String",
"options": {
"index": {
"unique": true
}
},
"validators": []
}user_printing
{
"path": "user_printing",
"instance": "Boolean",
"options": {
"default": false
},
"validators": [],
"defaultValue": false
}wifi_password
{
"path": "wifi_password",
"instance": "String",
"options": {},
"validators": []
}wifi_username
{
"path": "wifi_username",
"instance": "String",
"options": {},
"validators": []
}xero_id
{
"path": "xero_id",
"instance": "String",
"options": {},
"validators": []
}