EspoCRM – Open Source CRM Application
PHP calendarcontactscrmcrm-platformcrm-systemcustomer-portalcustomer-supportcustomizabledocumentsemail-marketingkanbanleadsopen-sourcephpplatformsales-automationsingle-page-applicationsupport
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM – Open Source CRM application.
* Copyright (C) 2014-2026 EspoCRM, Inc.
* Website: https://www.espocrm.com
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
* The interactive user interfaces in modified source and object code versions
* of this program must display Appropriate Legal Notices, as required under
* Section 5 of the GNU Affero General Public License version 3.
*
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
************************************************************************/
/** @module models/user */
import Model from 'model';
/**
* A user.
*/
class User extends Model {
name = 'User'
entityType = 'User'
urlRoot = 'User'
/**
* Is admin.
*
* @returns {boolean}
*/
isAdmin() {
return this.get('type') === 'admin' || this.isSuperAdmin();
}
/**
* Is portal.
*
* @returns {boolean}
*/
isPortal() {
return this.get('type') === 'portal';
}
/**
* Is API.
*
* @returns {boolean}
*/
isApi() {
return this.get('type') === 'api';
}
/**
* Is regular.
*
* @returns {boolean}
*/
isRegular() {
return this.get('type') === 'regular';
}
/**
* Is system.
*
* @returns {boolean}
*/
isSystem() {
return this.get('type') === 'system';
}
/**
* Is super-admin.
*
* @returns {boolean}
*/
isSuperAdmin() {
return this.get('type') === 'super-admin';
}
/**
* Is admin and is not stripped of admin capabilities.
*
* @return {boolean}
*
* @since 10.1.0
*/
isEffectiveAdmin() {
if (!this.isAdmin()) {
return false;
}
/** @type {string[]|null} */
const scopes = this.attributes.scopes;
if (scopes == null) {
return true;
}
return scopes.includes('Admin');
}
}
export default User;