usergroup.get

説明

integer/array usergroup.get(object parameters)

このメソッドを使用すると、指定したパラメータに従ってユーザーグループを取得できます。

このメソッドは、あらゆる種類のユーザーが利用できます。メソッドの呼び出し権限は、ユーザーロール設定で取り消すことができます。詳細はユーザーロールを参照してください。

パラメータ

(object) 目的の出力を定義するパラメータ。

このメソッドは、以下のパラメータをサポートしています。

パラメータ 型 説明
mfaids ID/array 指定したMFA方式を持つユーザーグループのみを返します。

パラメータの動作:
- Super admin タイプのユーザーでサポート
mfa_status integer 指定したMFAステータスを持つユーザーグループのみを返します。

サポートされているステータスの一覧については、ユーザーグループのページを参照してください。
proxyids ID/array 指定したプロキシを含むユーザーグループのみを返します。

パラメータの動作:
- Super admin タイプのユーザーでサポート
proxy_groupids ID/array 指定したプロキシグループを含むユーザーグループのみを返します。

パラメータの動作:
- Super admin タイプのユーザーでサポート
selectProxies ID/array ユーザーグループのプロキシを含む proxies プロパティを返します。

パラメータの動作:
- Super admin タイプのユーザーでサポート
selectProxyGroups ID/array ユーザーグループのプロキシグループを含む proxy_groups プロパティを返します。

パラメータの動作:
- Super admin タイプのユーザーでサポート
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.