[comment]: # translation:outdated

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

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

[comment]: # ({e6ce1619-ed6f4d70})
### Descrição  
  
`integer/array role.get(object parameters)`  
  
O método permite recuperar roles de acordo com os parâmetros fornecidos.  
  
::: noteclassic  
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Consulte [Funções de usuário](/manual/web_interface/frontend_sections/administration/user_roles) para obter mais informações.
:::

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

[comment]: # ({4605e5ba-3b10ad42})
### Parâmetros

`(object)` Parâmetros que definem a saída desejada.

O método oferece suporte aos parâmetros a seguir.  
  
|Parâmetro|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|roleids|string/array|Retornar apenas papéis com os IDs fornecidos.|
|selectRules|query|Retornar regras de função na propriedade [rules](/manual/api/reference/role/object#role_rules).|
|selectUsers|query|Retornar regras de função na propriedade [rules](/manual/api/reference/role/object#role_rules).|
|sortfield|string/array|Classifique o resultado pelas propriedades fornecidas.<br><br>Os valores possíveis são: `roleid`, `name`.|
|countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos `get` são descritos em detalhes na página [comentário de referência](/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]: # ({/4605e5ba-3b10ad42})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno  
  
`(integer/array)` Retorna:  
  
- uma matriz de objetos;  
- a contagem de objetos recuperados, se o parâmetro `countOutput` foi usado.

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

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

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

[comment]: # ({2abf4f87-ac3322b8})
#### Recuperando dados de função  
  
Recupere os dados da função "Função de superadministrador" e suas regras de acesso.

Request:

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

Response:

```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": "monitoring.services",
                        "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": "reports.notifications",
                        "status": "1"
                    },
                    {
                        "name": "reports.scheduled_reports",
                        "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.actions",
                        "status": "1"
                    },
                    {
                        "name": "configuration.discovery",
                        "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.general",
                        "status": "1"
                    },
                    {
                        "name": "administration.proxies",
                        "status": "1"
                    },
                    {
                        "name": "administration.authentication",
                        "status": "1"
                    },
                    {
                        "name": "administration.user_groups",
                        "status": "1"
                    },
                    {
                        "name": "administration.user_roles",
                        "status": "1"
                    },
                    {
                        "name": "administration.users",
                        "status": "1"
                    },
                    {
                        "name": "administration.media_types",
                        "status": "1"
                    },
                    {
                        "name": "administration.scripts",
                        "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": "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"
                    }
                ],
                "actions.default_access": "1"
            }
        }
    ],
    "id": 1
}
```

[comment]: # ({/2abf4f87-ac3322b8})

[comment]: # ({f3933c89-f3933c89})
### Veja também

-   [Regras de função](/manual/api/reference/role/object#role_rules)
-   [Usuário](/manual/api/reference/user/object#user)

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

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

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

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