User
The IUser interface represents the User object defining the properties and their types that can be associated with a user. User information is stored in the users
collection on MongoDB.
For more information and details on the Interface and sub-Interfaces, see the code here
User Object
Fields
The User object has these fields with the following data types.
| string | The unique identifier for the user. |
createdAt | Date | The date and time when the user was created. |
roles | Array of strings | An array of role IDs associated with the user. Eg "user", "admin", “livechat-agent” |
type | string | The type of user. E.g. “user”, “app” or “bot” |
active | boolean | Indicates whether the user is active or not. |
username | string | The username of the user. |
nickname | string | The nickname of the user. |
name | string | The name of the user. |
services | object | Additional services associated with the user. |
emails | Array of objects | An array of email objects associated with the user. |
status | string | The status of the user. |
statusConnection | string | The status connection of the user. |
lastLogin | Date | The date and time of the user's last login. |
bio | string | The biography or description of the user. |
avatarOrigin | string | The origin of the user's avatar. |
avatarETag | string | The ETag of the user's avatar. |
avatarUrl | string | The URL of the user's avatar. |
utcOffset | number | The UTC offset of the user's timezone. |
language | string | The language preference of the user. |
statusDefault | string | The default status of the user. |
statusText | string | The custom status text of the user. |
oauth | object | OAuth information associated with the user. |
_updatedAt | Date | The date and time when the user object was last updated. |
e2e | object | End-to-end encryption information associated with the user. |
requirePasswordChange | boolean | Indicates whether the user needs to change their password. |
customFields | object | Additional custom fields associated with the user. |
settings | object | User-specific settings. |
defaultRoom | string | The ID of the user's default room. |
ldap | boolean | Indicates whether the user is an LDAP user. |
extension | string | The extension associated with the user. |
inviteToken | string | The token for inviting the user. |
canViewAllInfo | boolean | Indicates whether the user can view all information. |
phone | string | The phone number associated with the user. |
reason | string | The reason associated with the user. |
federated | boolean | Indicates whether the user is a federated user. |
federation | object | Federation information associated with the user. |
banners | object | Banner information associated with the user. |
importIds | Array of strings | An array of import IDs associated with the user. |
Last updated