Zabbix

<?php

/*

** Copyright (C) 2001-2025 Zabbix SIA

**

** 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, version 3.

**

** 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/>.

**/

​

​

/**

 * Class containing methods for operations with user groups.

 */

class CUserGroup extends CApiService {

​

    public const ACCESS_RULES = [

        'get' => ['min_user_type' => USER_TYPE_ZABBIX_USER],

        'create' => ['min_user_type' => USER_TYPE_SUPER_ADMIN],

        'update' => ['min_user_type' => USER_TYPE_SUPER_ADMIN],

        'delete' => ['min_user_type' => USER_TYPE_SUPER_ADMIN]

    ];

​

    protected $tableName = 'usrgrp';

    protected $tableAlias = 'g';

    protected $sortColumns = ['usrgrpid', 'name'];

​

    public const OUTPUT_FIELDS = ['usrgrpid', 'name', 'gui_access', 'users_status', 'debug_mode', 'userdirectoryid',

        'mfa_status', 'mfaid'

    ];

​

    public const LIMITED_OUTPUT_FIELDS = ['usrgrpid', 'name', 'gui_access', 'users_status', 'debug_mode', 'mfa_status'];

​

    /**

     * Get user groups.

     *

     * @param array  $options

     * @param array  $options['usrgrpids']

     * @param array  $options['userids']

     * @param bool   $options['status']

     * @param bool   $options['selectUsers']

     * @param int    $options['count']

     * @param string $options['pattern']

     * @param int    $options['limit']

     * @param string $options['order']

     *

     * @return array

     */

    public function get($options = []) {

        $result = [];

​

        $sqlParts = [

            'select'    => ['usrgrp' => 'g.usrgrpid'],

            'from'      => ['usrgrp' => 'usrgrp g'],

            'where'     => [],

            'order'     => [],

            'limit'     => null

        ];

​

        $defOptions = [

            'usrgrpids'                 => null,

            'userids'                   => null,

            'status'                    => null,

            'mfa_status'                => null,

            // filter

            'searchByAny'               => null,

            'startSearch'               => false,

            'excludeSearch'             => false,

            'searchWildcardsEnabled'    => null,

            // output

            'editable'                  => false,

            'selectHostGroupRights'     => null,

            'selectTemplateGroupRights' => null,

            'selectTagFilters'          => null,

            'countOutput'               => false,

            'preservekeys'              => false,

            'sortfield'                 => '',

            'sortorder'                 => '',

            'limit'                     => null

        ];

​

        $options = zbx_array_merge($defOptions, $options);

​

        if (self::$userData['type'] == USER_TYPE_SUPER_ADMIN) {

            $usrgrps_output_fields = self::OUTPUT_FIELDS;

            $user_output_fields = CUser::OUTPUT_FIELDS;