Documentation
Table of Contents
usergroup.get
説明
integer/array usergroup.get(object parameters)
このメソッドでは、指定されたパラメーターに従ってユーザーグループを取得できます。
このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で 取り消すことができます。詳しくはユーザーの役割を参照してください。
パラメータ
(object) 目的の出力を定義するパラメーター。
このメソッドは、次のパラメーターをサポートします。
| パラメータ | タイプ | 説明 |
|---|---|---|
| status | integer | 指定されたステータスのユーザーグループのみを返します。 サポートされているステータスのリストについてはユーザーグループページを参照してください。 |
| userids | string/array | 指定されたユーザーを含むユーザーグループのみを返します |
| usrgrpids | string/array | 指定されたIDを持つユーザーグループのみを返します |
| selectTagFilters | query | tag_filtersプロパティでユーザーグループタグベースの権限を返します。 次のプロパティがあります： groupid - (string)ホストグループのIDtag - (string) タグ名value - (string)タグ値 |
| selectUsers | query | usersプロパティのユーザーグループからユーザーを返します |
| selectRights | query | rightsプロパティでユーザーグループの権限を返します。 次のプロパティがあります permission - (integer)アクセスレベル ホストグループid - (string) ホストグループのIDホストグループへのアクセスレベルのリストについてはユーザーグループページを参照してください。 |
| limitSelects | integer | 副選択によって返されるレコードの数を制限します |
| sortfield | string/array | 指定されたプロパティで結果を並べ替えます。 指定可能な値は usrgrpidとnameです。 |
| countOutput | boolean | すべてのgetメソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数
例
有効なユーザーグループの取得
有効なすべてのユーザーグループを取得します
Request:
{ "jsonrpc": "2.0", "method": "usergroup.get", "params": { "output": "extend", "status": 0 }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Response:
{ "jsonrpc": "2.0", "result": [ { "usrgrpid": "7", "name": "Zabbix administrators", "gui_access": "0", "users_status": "0", "debug_mode": "1" }, { "usrgrpid": "8", "name": "Guests", "gui_access": "0", "users_status": "0", "debug_mode": "0" }, { "usrgrpid": "11", "name": "Enabled debug mode", "gui_access": "0", "users_status": "0", "debug_mode": "1" }, { "usrgrpid": "12", "name": "No access to the frontend", "gui_access": "2", "users_status": "0", "debug_mode": "0" }, { "usrgrpid": "14", "name": "Read only", "gui_access": "0", "users_status": "0", "debug_mode": "0" }, { "usrgrpid": "18", "name": "Deny", "gui_access": "0", "users_status": "0", "debug_mode": "0" } ], "id": 1 }参照
ソース
CUserGroup::get() in ui/include/classes/api/services/CUserGroup.php.