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 User roles 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": "monitoring.services",
    33.                                "status": "1"
    34.                            },
    35.                            {
    36.                                "name": "inventory.overview",
    37.                                "status": "1"
    38.                            },
    39.                            {
    40.                                "name": "inventory.hosts",
    41.                                "status": "1"
    42.                            },
    43.                            {
    44.                                "name": "reports.availability_report",
    45.                                "status": "1"
    46.                            },
    47.                            {
    48.                                "name": "reports.top_triggers",
    49.                                "status": "1"
    50.                            },
    51.                            {
    52.                                "name": "monitoring.discovery",
    53.                                "status": "1"
    54.                            },
    55.                            {
    56.                                "name": "reports.notifications",
    57.                                "status": "1"
    58.                            },
    59.                            {
    60.                                "name": "reports.scheduled_reports",
    61.                                "status": "1"
    62.                            },
    64.                                "status": "1"
    65.                            },
    66.                            {
    67.                                "name": "configuration.templates",
    68.                                "status": "1"
    69.                            },
    70.                            {
    71.                                "name": "configuration.hosts",
    72.                                "status": "1"
    73.                            },
    74.                            {
    75.                                "name": "configuration.maintenance",
    76.                                "status": "1"
    77.                            },
    78.                            {
    79.                                "name": "configuration.actions",
    80.                                "status": "1"
    81.                            },
    82.                            {
    83.                                "name": "configuration.discovery",
    84.                                "status": "1"
    85.                            },
    86.                            {
    87.                                "name": "reports.system_info",
    88.                                "status": "1"
    89.                            },
    90.                            {
    91.                                "name": "reports.audit",
    92.                                "status": "1"
    93.                            },
    94.                            {
    95.                                "name": "reports.action_log",
    96.                                "status": "1"
    97.                            },
    98.                            {
    99.                                "name": "configuration.event_correlation",
    100.                                "status": "1"
    101.                            },
    102.                            {
    103.                                "name": "administration.general",
    104.                                "status": "1"
    105.                            },
    106.                            {
    107.                                "name": "administration.proxies",
    108.                                "status": "1"
    109.                            },
    110.                            {
    111.                                "name": "administration.authentication",
    112.                                "status": "1"
    113.                            },
    114.                            {
    115.                                "name": "administration.user_groups",
    116.                                "status": "1"
    117.                            },
    118.                            {
    119.                                "name": "administration.user_roles",
    120.                                "status": "1"
    121.                            },
    122.                            {
    123.                                "name": "administration.users",
    124.                                "status": "1"
    125.                            },
    126.                            {
    127.                                "name": "administration.media_types",
    128.                                "status": "1"
    129.                            },
    130.                            {
    131.                                "name": "administration.scripts",
    132.                                "status": "1"
    134.                                "name": "administration.queue",
    135.                                "status": "1"
    136.                            }
    137.                        ],
    138.                        "ui.default_access": "1",
    139.                        "services.read.mode": "1",
    140.                        "services.read.list": [],
    141.                        "services.read.tag": {
    142.                            "tag": "",
    143.                            "value": ""
    144.                        },
    145.                        "services.write.mode": "1",
    146.                        "services.write.list": [],
    147.                        "services.write.tag": {
    148.                            "tag": "",
    149.                            "value": ""
    150.                        },
    151.                        "modules": [],
    152.                        "modules.default_access": "1",
    153.                        "api.access": "1",
    154.                        "api.mode": "0",
    155.                        "api": [],
    156.                        "actions": [
    157.                            {
    158.                                "name": "edit_dashboards",
    159.                                "status": "1"
    160.                            },
    161.                            {
    162.                                "name": "edit_maps",
    163.                                "status": "1"
    164.                            },
    165.                            {
    166.                                "name": "acknowledge_problems",
    167.                                "status": "1"
    168.                            },
    169.                            {
    170.                                "name": "close_problems",
    171.                                "status": "1"
    172.                            },
    173.                            {
    174.                                "name": "change_severity",
    175.                                "status": "1"
    176.                            },
    177.                            {
    178.                                "name": "add_problem_comments",
    179.                                "status": "1"
    180.                            },
    181.                            {
    182.                                "name": "execute_scripts",
    183.                                "status": "1"
    184.                            },
    185.                            {
    186.                                "name": "manage_api_tokens",
    187.                                "status": "1"
    188.                            },
    189.                            {
    190.                                "name": "edit_maintenance",
    191.                                "status": "1"
    192.                            },
    193.                            {
    194.                                "name": "manage_scheduled_reports",
    195.                                "status": "1"
    196.                            }
    197.                        ],
    198.                        "actions.default_access": "1"
    199.                    }
    200.                }
    201.            ],
    203.        }

    Source