Table of Contents
usergroup.get
説明
integer/array usergroup.get(object parameters)
このメソッドは、指定されたパラメータに従ってユーザーグループを取得することができます。
このメソッドは、すべての種類のユーザーが利用できます。メソッドの呼び出し権限はユーザーロールの設定で取り消すことができます。詳細はユーザーロールを参照してください。
パラメーター
(object) 取得したい情報を定義するパラメーター。
このメソッドは以下のパラメーターをサポートします。
| パラメーター | 型 | 説明 |
|---|---|---|
| mfaids | ID/array | 指定したMFA方式を持つユーザーグループのみを返します。 パラメータの動作: - Super adminタイプのユーザーでサポート |
| mfa_status | integer | 指定したMFAステータスを持つユーザーグループのみを返します。 サポートされているステータスの一覧はユーザーグループページを参照してください。 |
| status | integer | 指定したステータスを持つユーザーグループのみを返します。 サポートされているステータスの一覧はユーザーグループページを参照してください。 |
| userids | ID/array | 指定したユーザーを含むユーザーグループのみを返します。 |
| usrgrpids | ID/array | 指定したIDのユーザーグループのみを返します。 |
| selectTagFilters | query | ユーザーグループのタグベースの権限をtag_filtersプロパティで返します。 |
| selectUsers | query | ユーザーグループのユーザーをusersプロパティで返します。ユーザータイプによる制限については user.getを参照してください。 |
| selectHostGroupRights | query | ユーザーグループのホストグループ権限をhostgroup_rightsプロパティで返します。ホストグループへのアクセスレベルの一覧はユーザーグループページを参照してください。 |
| selectTemplateGroupRights | query | ユーザーグループのテンプレートグループ権限をtemplategroup_rightsプロパティで返します。テンプレートグループへのアクセスレベルの一覧はユーザーグループページを参照してください。 |
| limitSelects | integer | サブセレクトで返されるレコード数を制限します。 |
| output | query | 返されるユーザーグループオブジェクトのプロパティ。 AdminおよびUserタイプのユーザーは、 usrgrpid, name, gui_access, users_status, debug_mode, mfa_statusのみ取得可能です。デフォルト: extend。 |
| sortfield | string/array | 指定したプロパティで結果をソートします。 指定可能な値: usrgrpid, name。 |
| countOutput | boolean | これらのパラメーターはリファレンス解説で説明されています。 |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
戻り値
(integer/array) 次のいずれかを返します:
- オブジェクトの配列
countOutputパラメータが使用されている場合、取得されたオブジェクトの数
例
有効なユーザーグループの取得
すべての有効なユーザーグループを取得します。
{
"jsonrpc": "2.0",
"method": "usergroup.get",
"params": {
"output": "extend",
"status": 0
},
"id": 1
}レスポンス:
{
"jsonrpc": "2.0",
"result": [
{
"usrgrpid": "7",
"name": "Zabbix administrators",
"gui_access": "0",
"users_status": "0",
"debug_mode": "1",
"userdirectoryid": "0",
"mfa_status": "0",
"mfaid": "0"
},
{
"usrgrpid": "8",
"name": "Guests",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0",
"userdirectoryid": "0",
"mfa_status": "0",
"mfaid": "0"
},
{
"usrgrpid": "11",
"name": "Enabled debug mode",
"gui_access": "0",
"users_status": "0",
"debug_mode": "1",
"userdirectoryid": "0",
"mfa_status": "0",
"mfaid": "0"
},
{
"usrgrpid": "12",
"name": "No access to the frontend",
"gui_access": "2",
"users_status": "0",
"debug_mode": "0",
"userdirectoryid": "0",
"mfa_status": "0",
"mfaid": "0"
},
{
"usrgrpid": "14",
"name": "Read only",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0",
"userdirectoryid": "0",
"mfa_status": "0",
"mfaid": "0"
},
{
"usrgrpid": "18",
"name": "Deny",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0",
"userdirectoryid": "0",
"mfa_status": "0",
"mfaid": "0"
}
],
"id": 1
}参照
ソース
CUserGroup::get() in ui/include/classes/api/services/CUserGroup.php.