[comment]: # translation:outdated

[comment]: # ({ce8d2bd2-ce8d2bd2})
# usergroup.get

[comment]: # ({/ce8d2bd2-ce8d2bd2})

[comment]: # ({ef79b8a9-ef79b8a9})
### 説明

`integer/array usergroup.get(object parameters)`

このメソッドでは、指定されたパラメーターに従ってユーザーグループを取得できます。

::: noteclassic
このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で
取り消すことができます。詳しくは[ユーザーの役割](/manual/web_interface/frontend_sections/administration/user_roles)を参照してください。
:::

[comment]: # ({/ef79b8a9-ef79b8a9})

[comment]: # ({ec24a83b-4be9c06e})
### パラメータ

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

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

|パラメータ|[タイプ](/manual/api/reference_commentary#data_types)|説明|
|--|--|------|
|status|integer|指定されたステータスのユーザーグループのみを返します。<br><br>サポートされているステータスのリストについては[ユーザーグループページ](object#user_group)を参照してください。|
|userids|string/array|指定されたユーザーを含むユーザーグループのみを返します|
|usrgrpids|string/array|指定されたIDを持つユーザーグループのみを返します|
|selectTagFilters|query|[tag\_filters](/manual/api/reference/usergroup/object#tag_based_permission)プロパティでユーザーグループタグベースの権限を返します。<br><br>次のプロパティがあります：<br>`groupid` - (string)ホストグループのID<br>`tag` - (string) タグ名<br>`value` - (string)タグ値|
|selectUsers|query|[users](/manual/api/reference/user/object#user)プロパティのユーザーグループからユーザーを返します|
|selectRights|query|[rights](/manual/api/reference/usergroup/object#permission)プロパティでユーザーグループの権限を返します。<br><br>次のプロパティがあります<br>`permission` - (integer)アクセスレベル ホストグループ<br>`id` - (string) ホストグループのID<br><br>ホストグループへのアクセスレベルのリストについては[ユーザーグループページ](object#permission)を参照してください。|
|limitSelects|integer|副選択によって返されるレコードの数を制限します|
|sortfield|string/array|指定されたプロパティで結果を並べ替えます。<br><br>指定可能な値は`usrgrpid`と`name`です。|
|countOutput|boolean|すべての`get`メソッドに共通するこれらのパラメーターについては[リファレンス解説](/manual/api/reference_commentary#common_get_method_parameters)ページで詳しく説明されています|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/ec24a83b-4be9c06e})

[comment]: # ({7223bab1-7223bab1})
### 戻り値

`(integer/array)` 次のいずれかを返します:

-   オブジェクトの配列
-   `countOutput`パラメータが使用されている場合、取得されたオブジェクトの数

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### 例

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({a3c99a8f-62cd5d8e})
#### 有効なユーザーグループの取得

有効なすべてのユーザーグループを取得します

Request:

```json
{
    "jsonrpc": "2.0",
    "method": "usergroup.get",
    "params": {
        "output": "extend",
        "status": 0
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Response:

```json
{
    "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
}
```

[comment]: # ({/a3c99a8f-62cd5d8e})

[comment]: # ({039ccba1-039ccba1})
### 参照

-   [User](/manual/api/reference/user/object#user)

[comment]: # ({/039ccba1-039ccba1})

[comment]: # ({e72b2ac9-e72b2ac9})
### ソース

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

[comment]: # ({/e72b2ac9-e72b2ac9})