[comment]: # translation:outdated

[comment]: # ({619023b5-619023b5})
# role.get

[comment]: # ({/619023b5-619023b5})

[comment]: # ({082b3945-ed6f4d70})
### Beschrijving

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

De methode maakt het mogelijk om rollen op te halen op basis van de opgegeven parameters.

::: noteclassic
Deze methode is beschikbaar voor gebruikers van elk type. Toestemmingen
om de methode te gebruiken, kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie [Gebruikersrollen](/manual/web_interface/frontend_sections/users/user_roles)
voor meer informatie.
:::

[comment]: # ({/082b3945-ed6f4d70})

[comment]: # ({1828aee9-3b10ad42})
### Parameters

`(object)` Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

|Parameter|[Type](/manual/api/reference_commentary#data_types)|Omschrijving|
|--|--|------|
|roleids|string/array|Alleen rollen met de opgegeven ID's retourneren.|
|selectRules|query|Rolregels retourneren in het [rules](/manual/api/reference/role/object#role_rules)-eigenschap.|
|selectUsers|query|Selecteer [gebruikers](/manual/api/reference/user/object) waaraan deze rol is toegewezen.|
|sortfield|string/array|Sorteer het resultaat op basis van de opgegeven eigenschappen.<br><br>Mogelijke waarden: `roleid`, `name`.|
|countOutput|boolean|Deze parameters, die gemeenschappelijk zijn voor alle `get`-methoden, worden in detail beschreven op de [referentiecommentaar](/manual/api/reference_commentary#common_get_method_parameters)-pagina.|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/1828aee9-3b10ad42})

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

`(integer/array)` Retourneert ofwel:

- een reeks objecten;
- het aantal opgehaalde objecten, als de `countOutput` parameter heeft
    gebruikt.

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

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

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

[comment]: # ({6eca0009-ac3322b8})
#### Opvragen van rolgegevens

Haal gegevens op van de rol "Superadmin" en zijn toegangsregels.

[Aanvraag](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "role.get",
    "params": {
        "output": "extend",
        "selectRules": "extend",
        "roleids": "3"
    },
    "id": 1
}
```

Reactie:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "roleid": "3",
            "name": "Superadmin",
            "type": "3",
            "readonly": "1",
            "rules": {
                "ui": [
                    {
                        "name": "monitoring.dashboard",
                        "status": "1"
                    },
                    {
                        "name": "monitoring.problems",
                        "status": "1"
                    },
                    {
                        "name": "monitoring.hosts",
                        "status": "1"
                    },
                    {
                        "name": "monitoring.latest_data",
                        "status": "1"
                    },
                    {
                        "name": "monitoring.maps",
                        "status": "1"
                    },
                    {
                        "name": "services.services",
                        "status": "1"
                    },
                    {
                        "name": "services.sla_report",
                        "status": "1"
                    },
                    {
                        "name": "inventory.overview",
                        "status": "1"
                    },
                    {
                        "name": "inventory.hosts",
                        "status": "1"
                    },
                    {
                        "name": "reports.availability_report",
                        "status": "1"
                    },
                    {
                        "name": "reports.top_triggers",
                        "status": "1"
                    },
                    {
                        "name": "monitoring.discovery",
                        "status": "1"
                    },
                    {
                        "name": "services.sla",
                        "status": "1"
                    },
                    {
                        "name": "reports.scheduled_reports",
                        "status": "1"
                    },
                    {
                        "name": "reports.notifications",
                        "status": "1"
                    },
                    {
                        "name": "configuration.template_groups",
                        "status": "1"
                    },
                    {
                        "name": "configuration.host_groups",
                        "status": "1"
                    },
                    {
                        "name": "configuration.templates",
                        "status": "1"
                    },
                    {
                        "name": "configuration.hosts",
                        "status": "1"
                    },
                    {
                        "name": "configuration.maintenance",
                        "status": "1"
                    },
                    {
                        "name": "configuration.discovery",
                        "status": "1"
                    },
                    {
                        "name": "configuration.trigger_actions",
                        "status": "1"
                    },
                    {
                        "name": "configuration.service_actions",
                        "status": "1"
                    },
                    {
                        "name": "configuration.discovery_actions",
                        "status": "1"
                    },
                    {
                        "name": "configuration.autoregistration_actions",
                        "status": "1"
                    },
                    {
                        "name": "configuration.internal_actions",
                        "status": "1"
                    },
                    {
                        "name": "reports.system_info",
                        "status": "1"
                    },
                    {
                        "name": "reports.audit",
                        "status": "1"
                    },
                    {
                        "name": "reports.action_log",
                        "status": "1"
                    },
                    {
                        "name": "configuration.event_correlation",
                        "status": "1"
                    },
                    {
                        "name": "administration.media_types",
                        "status": "1"
                    },
                    {
                        "name": "administration.scripts",
                        "status": "1"
                    },
                    {
                        "name": "administration.user_groups",
                        "status": "1"
                    },
                    {
                        "name": "administration.user_roles",
                        "status": "1"
                    },
                    {
                        "name": "administration.users",
                        "status": "1"
                    },
                    {
                        "name": "administration.api_tokens",
                        "status": "1"
                    },
                    {
                        "name": "administration.authentication",
                        "status": "1"
                    },
                    {
                        "name": "administration.general",
                        "status": "1"
                    },
                    {
                        "name": "administration.audit_log",
                        "status": "1"
                    },
                    {
                        "name": "administration.housekeeping",
                        "status": "1"
                    },
                    {
                        "name": "administration.proxies",
                        "status": "1"
                    },
                    {
                        "name": "administration.macros",
                        "status": "1"
                    },
                    {
                        "name": "administration.queue",
                        "status": "1"
                    }
                ],
                "ui.default_access": "1",
                "services.read.mode": "1",
                "services.read.list": [],
                "services.read.tag": {
                    "tag": "",
                    "value": ""
                },
                "services.write.mode": "1",
                "services.write.list": [],
                "services.write.tag": {
                    "tag": "",
                    "value": ""
                },
                "modules": [],
                "modules.default_access": "1",
                "api.access": "1",
                "api.mode": "0",
                "api": [],
                "actions": [
                    {
                        "name": "edit_dashboards",
                        "status": "1"
                    },
                    {
                        "name": "edit_maps",
                        "status": "1"
                    },
                    {
                        "name": "acknowledge_problems",
                        "status": "1"
                    },
                    {
                        "name": "suppress_problems",
                        "status": "1"
                    },
                    {
                        "name": "close_problems",
                        "status": "1"
                    },
                    {
                        "name": "change_severity",
                        "status": "1"
                    },
                    {
                        "name": "add_problem_comments",
                        "status": "1"
                    },
                    {
                        "name": "execute_scripts",
                        "status": "1"
                    },
                    {
                        "name": "manage_api_tokens",
                        "status": "1"
                    },
                    {
                        "name": "edit_maintenance",
                        "status": "1"
                    },
                    {
                        "name": "manage_scheduled_reports",
                        "status": "1"
                    },
                    {
                        "name": "manage_sla",
                        "status": "1"
                    },
                    {
                        "name": "invoke_execute_now",
                        "status": "1"
                    }
                ],
                "actions.default_access": "1"
            }
        }
    ],
    "id": 1
}
```

[comment]: # ({/6eca0009-ac3322b8})

[comment]: # ({f3933c89-f3933c89})
### Zie ook

- [Rolregels](/manual/api/reference/role/object#role_rules)
- [Gebruiker](/manual/api/referentie/gebruiker/object#gebruiker)

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

[comment]: # ({780eeb68-780eeb68})
### Bron

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

[comment]: # ({/780eeb68-780eeb68})