Documentation
Table of Contents
> Roleオブジェクト
次のオブジェクトは、roleAPIに直接関連しています。
Role
roleオブジェクトには、次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| roleid | string | (読取専用)ロールID |
| name (必須) |
string | ロール名 |
| type (必須) |
integer | ユーザータイプ 使用可能な値: 1 - (デフォルト)ユーザー 2 - 管理者 3 - 特権管理者 |
| readonly | integer | (読取専用)ロールが読み取り専用かどうか 使用可能な値: 0 - (デフォルト)いいえ 1 - はい |
Role rules
role rules オブジェクトには次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| ui | array | UI element オブジェクトの配列 |
| ui.default_access | integer | 新しい UIエレメントへのアクセスを有効にするかどうか。 使用可能な値： 0 - 無効 1 - (デフォルト) 有効 |
| services.read.mode | integer | サービスへの読み取り専用アクセス。 使用可能な値： 0 - services.read.listで指定されるか、services.read.tagプロパティで一致するサービスへの読み取り専用アクセス。1 - (デフォルト) すべてのサービスへの読み取り専用アクセス。 |
| services.read.list | array | Service オブジェクトの配列。 子サービスを含む指定されたサービスには、ユーザー ロールへの読み取り専用アクセスが付与されます。 読み取り専用アクセスは、サービスへの読み取り/書き込みアクセスをオーバーライドしません。 services.read.mode が 0 に設定されている場合にのみ使用されます。 |
| services.read.tag | object | Service tag オブジェクトの配列。 タグに一致するサービス (子サービスを含む) には、ユーザー ロールへの読み取り専用アクセスが付与されます。 読み取り専用アクセスは、サービスへの読み取り/書き込みアクセスをオーバーライドしません。 services.read.mode が 0 に設定されている場合にのみ使用されます。 |
| services.write.mode | integer | サービスへの読み取り/書き込みアクセス。 使用可能な値: 0 - (デフォルト) サービスへの読み書きアクセス。 services.write.list で指定されるか、services.write.tag プロパティで一致します。1 - すべてのサービスへの読み取り/書き込みアクセス。 |
| services.write.list | array | Service オブジェクトの配列。 子サービスを含む指定されたサービスには、ユーザー ロールへの読み取り/書き込みアクセスが付与されます。 読み取り/書き込みアクセスは、サービスへの読み取り専用アクセスをオーバーライドします。 services.write.mode が 0 に設定されている場合にのみ使用されます。 |
| services.write.tag | object | Service tag オブジェクトの配列。 タグに一致するサービス (子サービスを含む) には、ユーザー ロールへの読み取り/書き込みアクセスが付与されます。 読み取り/書き込みアクセスは、サービスへの読み取り専用アクセスをオーバーライドします。 services.write.mode が 0 に設定されている場合にのみ使用されます。 |
| modules | array | module オブジェクトの配列 |
| modules.default_access | integer | 新しいモジュールへのアクセスを有効にするか 使用可能な値： 0 - 無効 1 - (デフォルト) 有効 |
| api.access | integer | API へのアクセスが有効か 使用可能な値： 0 - 無効 1 - (デフォルト) 有効 |
| api.mode | integer | api プロパティにリストされた API メソッドを処理するためのモード使用可能な値： 0 - (デフォルト) 拒否リスト 1 - 許可リスト |
| api | array | API メソッドの配列。 |
| actions | array | action オブジェクトの配列。 |
| actions.default_access | integer | 新しいアクションへのアクセスを有効にするか 使用可能な値： 0 - 無効 1 - (デフォルト) 有効 |
UI element
UI elementオブジェクトには、次のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| name (必須) |
string | UIエレメント名 使用可能な値： monitoring.dashboard - 監視データ → ダッシュボード;monitoring.problems - 監視データ → 障害;monitoring.hosts - 監視データ → ホスト;monitoring.latest_data - 監視データ → 最新データ;monitoring.maps - 監視データ → マップ;services.services - サービス → サービス;services.sla_report - サービス → SLAレポート;inventory.overview - インベントリ → 概要;inventory.hosts - インベントリ → ホスト;reports.availability_report - レポート → 稼働レポート;reports.top_triggers - レポート → 障害発生数上位100項目.管理者および特権管理者ユーザー タイプのみ使用可能な値: monitoring.discovery - 監視データ → ディスカバリ;services.actions - サービス → サービスアクション;services.sla - サービス → SLA;reports.scheduled_reports - レポート → 定期レポート;reports.notifications - レポート → 通知レポート;configuration.host_groups - 設定 → ホストグループ;configuration.templates - 設定 → テンプレート;configuration.hosts - 設定 → ホスト;configuration.maintenance - 設定 → メンテナンス;configuration.actions - 設定 → アクション;configuration.discovery - 設定 → ディスカバリ.特権管理者ユーザー タイプのみ使用可能な値: reports.system_info - レポート → システム情報;reports.audit - レポート → 監査;reports.action_log - レポート → アクションログ;configuration.event_correlation - 設定 → イベント相関関係;administration.general - 管理 → 一般設定;administration.proxies - 管理 → プロキシ;administration.authentication - 管理 → 認証;administration.user_groups - 管理 → ユーザーグループ;administration.user_roles - 管理 → ユーザーロール;administration.users - 管理 → ユーザー;administration.media_types - 管理 → メディアタイプ;administration.scripts - 管理 → スクリプト;administration.queue - 管理 → キュー |
| status | integer | UI 要素へのアクセスが有効か 使用可能な値： 0 - 無効 1 - (デフォルト) 有効 |
Service
| プロパティ | タイプ | 説明 |
|---|---|---|
| serviceid (必須) |
string | サービスID |
Service tag
| プロパティ | タイプ | 説明 |
|---|---|---|
| tag (必須) |
string | タグ名 空の文字列が指定されている場合、サービスタグはサービスマッチングに使用されません。 |
| value | string | タグ値 値がないか空の文字列の場合、サービスの照合にはタグ名のみが使用されます。 |
Module
module オブジェクトには次のプロパティがあります
| プロパティ | タイプ | 説明 |
|---|---|---|
| moduleid (必須) |
string | モジュールID |
| status | integer | モジュールへのアクセスが有効か 使用可能な値： 0 - 無効 1 - (デフォルト)有効 |
Action
action オブジェクトには次のプロパティがあります
| プロパティ | タイプ | 説明 |
|---|---|---|
| name (必須) |
string | アクション名 任意のタイプのユーザーに可能な値： edit_dashboards - ダッシュボードの作成と編集edit_maps - マップの作成と編集add_problem_comments - 障害のコメント追加change_severity - 障害の深刻度を変更acknowledge_problems - 障害を確認close_problems - 障害をクローズしますexecute_scripts - スクリプトを実行manage_api_tokens - APIトークンを管理AdminおよびSuperadmin ユーザータイプのユーザーにのみ可能な値： edit_maintenance - メンテナンスの作成および編集manage_scheduled_reports - レポートのスケジュール管理 |
| status | integer | アクションを実行するためのアクセスが有効か 使用可能な値： 0 - 無効 1 - (デフォルト)有効 |