role.get

Descrição

integer/array role.get(object parameters)

O método permite recuperar funções de acordo com os parâmetros fornecidos.

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. Veja Funções de usuário para mais informações.

Parâmetros

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

O método suporta os seguintes parâmetros.

Parâmetro Tipo Descrição
roleids ID/array Retornar apenas funções com os IDs fornecidos.
selectRules query Retornar uma propriedade rules com as regras da função.
selectUsers query Retornar uma propriedade users com os usuários aos quais a função está atribuída.

Veja user.get para restrições baseadas no tipo de usuário.
sortfield string/array Classificar o resultado pelas propriedades fornecidas.

Valores possíveis: roleid, name.
countOutput boolean Esses parâmetros são descritos no comentário de referência.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(integer/array) Retorna:

  • uma matriz de objetos;
  • a contagem de objetos recuperados, se o parâmetro countOutput foi usado.

Exemplos

Recuperando dados de função

Recupere os dados da função "Super admin role" e suas regras de acesso.

Requisição:

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

Resposta:

{
    "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"
                    }
                ],
                "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"
                    }
                ],
                "actions.default_access": "1"
            }
        }
    ],
    "id": 1
}

Veja também

Fonte

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