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

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

[comment]: # ({082b3945-ed6f4d70})
### Descripción

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

El método permite recuperar roles según los parámetros dados.

::: noteclassic
Este método está disponible para usuarios de cualquier tipo. Los permisos
para llamar al método se pueden revocar en la configuración de roles de usuario. Ver [Roles de
usuario](/manual/web_interface/frontend_sections/users/user_roles)
para obtener más información.
:::

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

[comment]: # ({bbaaacbe-3b10ad42})
### Parámetros

`(objeto)` Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

|Parámetro|[Tipo](/manual/api/reference_commentary#data_types)|Descripción|
|--|--|------|
|roleids|cadena/matriz|Devuelve solo roles con los ID proporcionados.|
|selectRules|query|Devuelve reglas de rol en la propiedad [rules](/manual/api/reference/role/object#role_rules).|
|selectUsers|consulta|Seleccione [usuarios](/manual/api/reference/user/object) a los que está asignado este rol.|
|sortfield|cadena/matriz|Ordena el resultado según las propiedades dadas.<br><br>Valores posibles: `roleid`, `name`.|
|countOutput|booleano|Estos parámetros, que son comunes para todos los métodos `get`, se describen en detalle en la página [comentario de referencia](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|booleano|^|
|excludeSearch|booleano|^|
|filter|objeto|^|
|limit|entero|^|
|output|consulta|^|
|preservekeys|booleano|^|
|search|objeto|^|
|searchByAny|booleano|^|
|searchWildcardsEnabled|booleano|^|
|sortorder|cadena/matriz|^|
|startSearch|booleano|^|

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

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno

`(entero/matriz)` Devuelve:

- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro `countOutput` 
    ha sido usado.

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

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

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

[comment]: # ({6eca0009-ac3322b8})
#### Recuperando datos de rol

Recupere datos de rol de "rol de superadministrador" y sus reglas de acceso.

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

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

Respuesta:

```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.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})
### Ver también

-   [Reglas de rol](/manual/api/reference/role/object#role_rules)
-   [Usuario](/manual/api/reference/user/object#user)

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

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

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

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