[comment]: # ({619023b5-619023b5})
# role.get
[comment]: # ({/619023b5-619023b5})
[comment]: # ({082b3945-ed6f4d70})
### Beschreibung
`integer/array role.get(object parameters)`
Mit dieser Methode können Rollen entsprechend den angegebenen Parametern abgerufen werden.
::: noteclassic
Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen
zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter [Benutzerrollen](/manual/web_interface/frontend_sections/users/user_roles).
:::
[comment]: # ({/082b3945-ed6f4d70})
[comment]: # ({24ee63f1-3b10ad42})
### Parameter
`(object)` Parameter, die die gewünschte Ausgabe definieren.
Die Methode unterstützt die folgenden Parameter.
|Parameter|[Typ](/manual/api/reference_commentary#data-types)|Beschreibung|
|--|--|------|
|roleids|ID/array|Gibt nur Rollen mit den angegebenen IDs zurück.|
|selectRules|query|Gibt eine Eigenschaft [`rules`](/manual/api/reference/role/object#role-rules) mit den Rollenregeln zurück.|
|selectUsers|query|Gibt eine Eigenschaft [`users`](/manual/api/reference/user/object) mit den Benutzern zurück, denen die Rolle zugewiesen ist.
Siehe [`user.get`](/manual/api/reference/user/get) für Einschränkungen basierend auf dem Benutzertyp.|
|sortfield|string/array|Sortiert das Ergebnis nach den angegebenen Eigenschaften.
Mögliche Werte: `roleid`, `name`.|
|countOutput|boolean|Diese Parameter sind in den [Referenzkommentaren](/manual/api/reference_commentary#common-get-method-parameters) beschrieben.|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
[comment]: # ({/24ee63f1-3b10ad42})
[comment]: # ({7223bab1-7223bab1})
### Rückgabewerte
`(integer/array)` Gibt entweder Folgendes zurück:
- ein Array von Objekten;
- die Anzahl der abgerufenen Objekte, wenn der Parameter `countOutput` verwendet wurde.
[comment]: # ({/7223bab1-7223bab1})
[comment]: # ({b41637d2-b41637d2})
### Beispiele
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({cca01236-ac3322b8})
#### Abrufen von Rollendaten
Rufen Sie die Rollendaten der Rolle "Super admin role" und ihre Zugriffsregeln ab.
[Anfrage](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "role.get",
"params": {
"output": "extend",
"selectRules": "extend",
"roleids": "3"
},
"id": 1
}
```
Antwort:
```json
{
"jsonrpc": "2.0",
"result": [
{
"roleid": "3",
"name": "Super admin role",
"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.proxy_groups",
"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": [
{
"moduleid": 1,
"status": "1"
},
{
"moduleid": 2,
"status": "1"
},
{
"moduleid": 3,
"status": "1"
},
{
"moduleid": 4,
"status": "1"
},
{
"moduleid": 5,
"status": "1"
},
{
"moduleid": 6,
"status": "1"
},
{
"moduleid": 7,
"status": "1"
},
{
"moduleid": 8,
"status": "1"
},
{
"moduleid": 9,
"status": "1"
},
{
"moduleid": 10,
"status": "1"
},
{
"moduleid": 11,
"status": "1"
},
{
"moduleid": 12,
"status": "1"
},
{
"moduleid": 13,
"status": "1"
},
{
"moduleid": 14,
"status": "1"
},
{
"moduleid": 15,
"status": "1"
},
{
"moduleid": 16,
"status": "1"
},
{
"moduleid": 17,
"status": "1"
},
{
"moduleid": 18,
"status": "1"
},
{
"moduleid": 19,
"status": "1"
},
{
"moduleid": 20,
"status": "1"
},
{
"moduleid": 21,
"status": "1"
},
{
"moduleid": 22,
"status": "1"
},
{
"moduleid": 23,
"status": "1"
},
{
"moduleid": 24,
"status": "1"
},
{
"moduleid": 25,
"status": "1"
},
{
"moduleid": 26,
"status": "1"
},
{
"moduleid": 27,
"status": "1"
},
{
"moduleid": 28,
"status": "1"
},
{
"moduleid": 29,
"status": "1"
},
{
"moduleid": 30,
"status": "1"
},
{
"moduleid": 31,
"status": "1"
},
{
"moduleid": 32,
"status": "1"
}
],
"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"
},
{
"name": "change_problem_ranking",
"status": "1"
},
{
"name": "edit_own_media",
"status": "1"
},
{
"name": "edit_user_media",
"status": "1"
}
],
"actions.default_access": "1"
}
}
],
"id": 1
}
```
[comment]: # ({/cca01236-ac3322b8})
[comment]: # ({fb2cd4e4-f3933c89})
### Siehe auch
- [Rollenregeln](/manual/api/reference/role/object#role-rules)
- [Benutzer](/manual/api/reference/user/object#user)
[comment]: # ({/fb2cd4e4-f3933c89})
[comment]: # ({780eeb68-780eeb68})
### Quelle
CRole::get() in *ui/include/classes/api/services/CRole.php*.
[comment]: # ({/780eeb68-780eeb68})