Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

role.get

説明

integer/array role.get(object parameters)

このメソッドで、指定されたパラメーターに従ってロールを取得できます。

このメソッドはどのタイプのユーザーでも利用可能です。このメソッドを呼び出す権限は、ユーザーロール設定で取り消すことができます。詳しくはユーザーの役割を参照してください。

パラメータ

(object) 目的の出力を定義するパラメーター

このメソッドは、次のパラメーターをサポートします

パラメータ タイプ 説明
roleids string/array 指定されたIDを持つロールのみを返します
selectRules query rulesプロパティでロールルールを返します
selectUsers query この役割が割り当てられているユーザーを選択します
sortfield string/array 指定されたプロパティで結果を並べ替えます

利用可能な値はroleid,nameです
countOutput boolean すべてのgetメソッドに共通するこれらのパラメーターについてはリファレンス解説ページで詳しく説明されています。
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

戻り値

(integer/array) 次のいずれかを返します:

  • オブジェクトの配列
  • countOutputパラメータが使用されている場合、取得されたオブジェクトの数

ロールデータの取得

"スーパー管理者ロール"のロール データとそのアクセス ルールを取得します。

Request:

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

Response:

{
           "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
       }

参照

ソース

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