role.get

Descripción

integer/array role.get(object parameters)

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

Este método está disponible para usuarios de cualquier tipo. Permisos para activar el método se puede revocar en la configuración de roles de usuario. Ver User roles para más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
roleids cadena/matriz Devuelve solo roles con los ID proporcionados.
selectRules consulta Devuelve reglas de rol en la propiedad rules.
selectUsers consulta Seleccione users a los que están asignado este rol.
sortfield cadena/matriz Ordena el resultado según las propiedades dadas.

Los valores posibles son: roleid, name.
countOutput booleano Estos parámetros, que son comunes para todos los métodos get, se describen en detalle en la página reference commentary.
editable booleano
excluirBuscar booleano
filtro objeto
limite número entero
salida consulta
preservekeys booleano
buscar objeto
searchByAny booleano
searchWildcardsEnabled booleano
clasificación cadena/matriz
iniciarBuscar booleano

Valores de retorno

(entero/matriz)Devuelve:

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

Ejemplos

Recuperar datos de rol

Recuperar "Super rol de admin" datos de rol y sus reglas de acceso.
Solicitud: json { "jsonrpc": "2.0", "method": "role.get", "params": { "output": "extend", "selectRules": "extend", "roleids": "3" }, "auth": "3a57200802b24cda67c4e4010b50c065", "id": 1 }
Respuesta: json { "jsonrpc": "2.0", "result": [ { "roleid": "3", "name": "Super admin role", "type": "3", "readonly": "1", "rules": { "ui": [ { "name": "inventory.hosts", "status": "1" }, { "name": "inventory.overview", "status": "1" }, { "name": "monitoring.dashboard", "status": "1" }, { "name": "monitoring.hosts", "status": "1" }, { "name": "monitoring.latest_data", "status": "1" }, { "name": "monitoring.maps", "status": "1" }, { "name": "monitoring.problems", "status": "1" }, { "name": "reports.availability_report", "status": "1" }, { "name": "reports.top_triggers", "status": "1" }, { "name": "services.services", "status": "1" }, { "name": "services.sla_report", "status": "1" }, { "name": "configuration.actions", "status": "1" }, { "name": "configuration.discovery", "status": "1" }, { "name": "configuration.host_groups", "status": "1" }, { "name": "configuration.hosts", "status": "1" }, { "name": "configuration.maintenance", "status": "1" }, { "name": "configuration.templates", "status": "1" }, { "name": "monitoring.discovery", "status": "1" }, { "name": "reports.notifications", "status": "1" }, { "name": "reports.scheduled_reports", "status": "1" }, { "name": "services.actions", "status": "1" }, { "name": "services.sla", "status": "1" }, { "name": "administration.authentication", "status": "1" }, { "name": "administration.general", "status": "1" }, { "name": "administration.media_types", "status": "1" }, { "name": "administration.proxies", "status": "1" }, { "name": "administration.queue", "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": "configuration.event_correlation", "status": "1" }, { "name": "reports.action_log", "status": "1" }, { "name": "reports.audit", "status": "1" }, { "name": "reports.system_info", "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" }, { "name": "manage_sla", "status": "1" } ], "actions.default_access": "1" } } ], "id": 1 }

Ver también

Fuente

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