User Class

An object representing a User entity.

Properties

Name	Type	Description	Example
_id	string	User object ID	"5d08d3e6439cf8ea7d5b240a"
email	string	User email address (unique)	"moti.gra@sisense.com"
roleId	string	User role object ID	"5d08d3e6439cf8ea7d5b23b3"
roleName	string	User role name	"super"
baseRoleName	string	User base role name	"super"
userName	string	Username	"moti.gra@sisense.com"
firstName	string	First name	"moti.gra"
active	boolean	Is user active (enabled)	true
created	string	User creation timestamp	"2019-06-18T12:07:02.555Z"
lastUpdated	string	User last change timestamp	"2019-12-18T17:48:39.562Z"
lastLogin	string	User last login timestamp	"2019-12-18T17:48:39.562Z"
lastActivity	string	User last activity timestamp	"2019-12-18T17:48:39.535Z"
preferredLanguage	string	User language setting	"en-US"
groups	string[]	User group object IDs	["5d08d3e6fd8669121860f817"]
preferences	object	User settings	See User Preferences
userAuth	object	User permission schema

Sub-types

User Preferences

"preferences": {
    "localeId": "en-US"
}

Example

{
  "_id": "5d08d3e6439cf8ea7d5b240a",
  "email": "moti.gra@sisense.com",
  "roleId": "5d08d3e6439cf8ea7d5b23b3",
  "userName": "moti.gra@sisense.com",
  "firstName": "moti.gra",
  "active": true,
  "created": "2019-06-18T12:07:02.555Z",
  "lastUpdated": "2019-12-18T17:48:39.562Z",
  "lastLogin": "2019-12-18T17:48:39.562Z",
  "preferences": {
    "localeId": "en-US"
  },
  "lastActivity": "2019-12-18T17:48:39.535Z",
  "groups": [
    "5d08d3e6fd8669121860f817"
  ],
  "roleName": "super",
  "baseRoleName": "super",
  "groupsName": [
    {
      "id": "5d08d3e6fd8669121860f817",
      "name": "Admins"
    }
  ],
  "userAuth": {
    "folders": {
      "create": true,
      "modify": true,
      "delete": true,
      "duplicate": true
    },
    "dashboards": {
      "create": true,
      "delete": true,
      "move": true,
      "rename": true,
      "duplicate": true,
      "change_owner": true,
      "toggle_edit_mode": true,
      "edit_layout": true,
      "edit_script": true,
      "export_dash": true,
      "export_jpeg": true,
      "export_pdf": true,
      "share": true,
      "restore": true,
      "copy_to_server": true,
      "import": true,
      "select_palette": true,
      "replace_datasource": true,
      "undo_import_dash": true,
      "toggleDataExploration": true,
      "filters": {
        "create": true,
        "delete": true,
        "save": true,
        "on_off": true,
        "toggle_expansion": true,
        "modify": true,
        "reorder": true,
        "modify_type": true,
        "toggle_auto_update": true,
        "set_defaults": true,
        "advanced": true,
        "use_starred": true
      }
    },
    "widgets": {
      "create": true,
      "delete": true,
      "rename": true,
      "duplicate": true,
      "copy_to_dashboard": true,
      "edit": true,
      "edit_script": true,
      "change_type": true,
      "export_csv": true,
      "export_png": true,
      "export_svg": true,
      "export_pdf": true,
      "modify_selection_attrs": true,
      "modify_selection_mode": true,
      "drill_to_anywhere": true,
      "add_to_pulse": true,
      "items": {
        "create": true,
        "delete": true,
        "rename": true,
        "modify": true,
        "reorder": true,
        "modify_type": true,
        "modify_format": true,
        "on_off": true,
        "select_hierarchies": true
      },
      "filters": {
        "create": true,
        "delete": true,
        "save": true,
        "on_off": true,
        "toggle_expansion": true,
        "modify": true,
        "modify_layout": true,
        "modify_type": true,
        "modify_dashboard_filters": true,
        "use_starred": true
      }
    },
    "warnings": {
      "revisioner": true
    },
    "queries": {
      "impersonate": true
    },
    "manage": {
      "users": {
        "get": true,
        "add": true,
        "remove": true,
        "modify": true,
        "modify_me": true,
        "share_invitations": true,
        "search": true
      },
      "groups": {
        "get": true,
        "add": true,
        "remove": true,
        "modify": true,
        "modify_mygroups": true
      },
      "elasticubes": {
        "add": true,
        "remove": true,
        "modify": true,
        "modify_rights": true,
        "modify_rowrights": true,
        "modify_data_security_rights": true,
        "schedule_build": true,
        "import": true,
        "export": true,
        "sql_manual_queries": {
          "add": true,
          "get": true,
          "modify": true,
          "remove": true
        },
        "custom_tables": {
          "add": true,
          "get": true,
          "modify": true,
          "remove": true
        },
        "custom_fields": {
          "add": true,
          "get": true,
          "modify": true,
          "remove": true
        },
        "table_relations": {
          "add": true,
          "get": true,
          "modify": true,
          "remove": true
        }
      },
      "servers": {
        "get": true,
        "add": true,
        "remove": true,
        "modify_rights": true,
        "get_cubes": true,
        "cubes_info": true,
        "cubes_status": true
      },
      "palettes": {
        "add": true,
        "remove": true,
        "modify": true
      },
      "manage_data": true,
      "activedirectory": true,
      "sso": true,
      "systemconfig": true,
      "restapi": true,
      "branding": true,
      "security": true,
      "proxy": true
    },
    "system": {
      "logs": {
        "get": true,
        "add": true,
        "remove": true
      }
    },
    "reporting": {
      "execute": true
    },
    "subscription": {
      "get": true,
      "add": true,
      "remove": true,
      "modify": true
    },
    "pages": {
      "jaqleditor": true,
      "sqleditor": true
    },
    "base": {
      "isConsumer": false,
      "isContributor": false,
      "isAdmin": false,
      "isSuper": true
    },
    "elasticubes": {
      "sql_api": true,
      "check_users_permission": true
    },
    "usageAnalytics": {
      "base": true,
      "extended": true
    },
    "warehouse": {
      "add_warehouse": true,
      "create_view": true
    }
  },
  "preferredLanguage": "en-US"
}