role.get

    The method allows to retrieve roles according to the given parameters.

    This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See for more information.

    Parameters

    The method supports the following parameters.

    (integer/array) Returns either:

    • an array of objects;
    • the count of retrieved objects, if the countOutput parameter has been used.

    Examples

    Retrieving role data

    Request:

    Response:

    1. {
    2.            "jsonrpc": "2.0",
    3.            "result": [
    4.                {
    5.                    "roleid": "3",
    6.                    "name": "Super admin role",
    7.                    "type": "3",
    8.                    "readonly": "1",
    9.                    "rules": {
    10.                        "ui": [
    11.                            {
    12.                                "name": "monitoring.dashboard",
    13.                                "status": "1"
    14.                            },
    15.                            {
    16.                                "name": "monitoring.problems",
    17.                                "status": "1"
    18.                            },
    19.                            {
    20.                                "name": "monitoring.hosts",
    21.                                "status": "1"
    22.                            },
    23.                            {
    24.                                "name": "monitoring.latest_data",
    25.                                "status": "1"
    26.                            },
    27.                            {
    28.                                "name": "monitoring.maps",
    29.                                "status": "1"
    30.                            },
    31.                            {
    32.                                "name": "services.services",
    33.                                "status": "1"
    34.                            },
    35.                            {
    36.                                "name": "services.sla_report",
    37.                                "status": "1"
    38.                            },
    39.                            {
    40.                                "name": "inventory.overview",
    41.                                "status": "1"
    42.                            },
    43.                            {
    44.                                "name": "inventory.hosts",
    45.                                "status": "1"
    46.                            },
    47.                            {
    48.                                "name": "reports.availability_report",
    49.                                "status": "1"
    50.                            },
    51.                            {
    52.                                "name": "reports.top_triggers",
    53.                                "status": "1"
    54.                            },
    55.                            {
    56.                                "name": "monitoring.discovery",
    57.                                "status": "1"
    58.                            },
    59.                            {
    60.                                "name": "services.sla",
    61.                                "status": "1"
    62.                            },
    63.                            {
    64.                                "name": "reports.scheduled_reports",
    65.                                "status": "1"
    66.                            },
    67.                            {
    68.                                "name": "reports.notifications",
    69.                                "status": "1"
    70.                            },
    71.                            {
    72.                                "name": "configuration.template_groups",
    73.                                "status": "1"
    74.                            },
    75.                            {
    76.                                "name": "configuration.host_groups",
    77.                                "status": "1"
    78.                            },
    79.                            {
    80.                                "name": "configuration.templates",
    81.                                "status": "1"
    83.                                "name": "configuration.hosts",
    84.                                "status": "1"
    85.                            },
    86.                            {
    87.                                "name": "configuration.maintenance",
    88.                                "status": "1"
    89.                            },
    90.                            {
    91.                                "name": "configuration.discovery",
    92.                                "status": "1"
    93.                            },
    94.                            {
    95.                                "name": "configuration.trigger_actions",
    96.                                "status": "1"
    97.                            },
    98.                            {
    99.                                "name": "configuration.service_actions",
    100.                                "status": "1"
    101.                            },
    102.                            {
    103.                                "name": "configuration.discovery_actions",
    104.                                "status": "1"
    105.                            },
    106.                            {
    107.                                "name": "configuration.autoregistration_actions",
    108.                                "status": "1"
    109.                            },
    110.                            {
    111.                                "name": "configuration.internal_actions",
    112.                                "status": "1"
    113.                            },
    114.                            {
    115.                                "name": "reports.system_info",
    116.                                "status": "1"
    117.                            },
    118.                            {
    119.                                "name": "reports.audit",
    120.                                "status": "1"
    121.                            },
    122.                            {
    123.                                "name": "reports.action_log",
    124.                                "status": "1"
    125.                            },
    126.                            {
    127.                                "name": "configuration.event_correlation",
    128.                                "status": "1"
    129.                            },
    130.                            {
    131.                                "name": "administration.media_types",
    132.                                "status": "1"
    133.                            },
    134.                            {
    135.                                "name": "administration.scripts",
    136.                                "status": "1"
    137.                            },
    138.                            {
    139.                                "name": "administration.user_groups",
    140.                                "status": "1"
    141.                            },
    142.                            {
    143.                                "name": "administration.user_roles",
    144.                                "status": "1"
    145.                            },
    146.                            {
    147.                                "name": "administration.users",
    148.                                "status": "1"
    149.                            },
    150.                            {
    151.                                "name": "administration.api_tokens",
    152.                                "status": "1"
    153.                            },
    154.                            {
    155.                                "name": "administration.authentication",
    156.                                "status": "1"
    157.                            },
    158.                            {
    159.                                "name": "administration.general",
    160.                                "status": "1"
    161.                            },
    162.                            {
    163.                                "name": "administration.audit_log",
    164.                                "status": "1"
    165.                            },
    166.                            {
    167.                                "name": "administration.housekeeping",
    168.                                "status": "1"
    169.                            },
    170.                            {
    172.                            },
    173.                            {
    174.                                "name": "administration.macros",
    175.                                "status": "1"
    176.                            },
    177.                            {
    178.                                "name": "administration.queue",
    179.                                "status": "1"
    180.                            }
    181.                        ],
    182.                        "ui.default_access": "1",
    183.                        "services.read.mode": "1",
    184.                        "services.read.list": [],
    185.                        "services.read.tag": {
    186.                            "tag": "",
    187.                            "value": ""
    188.                        },
    189.                        "services.write.mode": "1",
    190.                        "services.write.list": [],
    191.                        "services.write.tag": {
    192.                            "tag": "",
    193.                            "value": ""
    194.                        },
    195.                        "modules": [],
    196.                        "modules.default_access": "1",
    197.                        "api.access": "1",
    198.                        "api.mode": "0",
    199.                        "api": [],
    200.                        "actions": [
    201.                            {
    202.                                "name": "edit_dashboards",
    203.                                "status": "1"
    204.                            },
    205.                            {
    206.                                "name": "edit_maps",
    207.                                "status": "1"
    208.                            },
    209.                            {
    210.                                "name": "acknowledge_problems",
    211.                                "status": "1"
    212.                            },
    213.                            {
    214.                                "name": "suppress_problems",
    215.                                "status": "1"
    216.                            },
    217.                            {
    218.                                "name": "close_problems",
    219.                                "status": "1"
    220.                            },
    221.                            {
    222.                                "name": "change_severity",
    223.                                "status": "1"
    224.                            },
    225.                            {
    226.                                "name": "add_problem_comments",
    227.                                "status": "1"
    228.                            },
    229.                            {
    230.                                "name": "execute_scripts",
    231.                                "status": "1"
    232.                            },
    233.                            {
    234.                                "name": "manage_api_tokens",
    235.                                "status": "1"
    236.                            },
    237.                            {
    238.                                "name": "edit_maintenance",
    239.                                "status": "1"
    240.                            },
    241.                            {
    242.                                "name": "manage_scheduled_reports",
    243.                                "status": "1"
    244.                            },
    245.                            {
    246.                                "name": "manage_sla",
    247.                                "status": "1"
    248.                            },
    249.                            {
    250.                                "name": "invoke_execute_now",
    251.                                "status": "1"
    252.                            }
    253.                        ],
    254.                        "actions.default_access": "1"
    255.                    }
    256.                }
    257.            ],
    258.            "id": 1

    Source