Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

usergroup.update

説明

object usergroup.update(object/array userGroups)

このメソッドでは既存のユーザーグループを更新できます。

このメソッドはSuper adminユーザータイプでのみ使用できます。 メソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。 詳細についてはユーザーの役割を参照してください。

パラメータ

(object/array) 更新するユーザーグループのプロパティ

usrgrpidプロパティは、ユーザーグループごとに定義する必要があります。すべてのプロパティはオプションです。 渡されたプロパティのみが更新され、他のプロパティは変更されません。

このメソッドは標準ユーザーグループプロパティに加えて次のパラメーターを受け入れます。

パラメータ タイプ 説明
rights object/array ユーザーグループに割り当てられている現在の権限を置き換えます
tag_filters array タグベースの権限をグループに割り当てます
users object/array Usersを使用して、ユーザーグループにユーザーを追加します。

ユーザーには、useridプロパティを定義する必要があります

戻り値

(object) usrgrpidsプロパティの下で更新されたユーザーグループのIDを含むオブジェクトを返します。

ユーザーグループの無効化

ユーザーグループを無効にします

Request:

{
           "jsonrpc": "2.0",
           "method": "usergroup.update",
           "params": {
               "usrgrpid": "17",
               "users_status": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Response:

{
           "jsonrpc": "2.0",
           "result": {
               "usrgrpids": [
                   "17"
               ]
           },
           "id": 1
       }

参照

ソース

CUserGroup::update() in ui/include/classes/api/services/CUserGroup.php.