Roleオブジェクト
次のオブジェクトは、roleAPIに直接関連しています。
ロール
ロールオブジェクトには以下のプロパティがあります:
| プロパティ | タイプ | 説明 |
|---|---|---|
| roleid | ID | ロールのID。 プロパティの動作: - 読み取り専用 - 更新操作では必須 |
| name | string | ロールの名前。 プロパティの動作: - 作成操作では必須 |
| type | integer | ユーザータイプ。 可能な値: 1 - (デフォルト) ユーザー; 2 - 管理者; 3 - スーパ管理者。 プロパティの動作: - 作成操作では必須 |
| readonly | integer | ロールが読み取り専用かどうか。 可能な値: 0 - (デフォルト) いいえ; 1 - はい。 プロパティの動作: - 読み取り専用 |
ロールルール
ロールルールオブジェクトには以下のプロパティがあります。
| プロパティ | 型 | 説明 |
|---|---|---|
| ui | array | UI要素オブジェクトの配列。 |
| ui.default_access | integer | 新しいUI要素へのアクセスが有効かどうか。 可能な値: 0 - 無効; 1 - (デフォルト) 有効。 |
| services.read.mode | integer | サービスへの読み取り専用アクセス。 可能な値: 0 - services.read.listで指定された、またはservices.read.tagで一致したサービスへの読み取り専用アクセス;1 - (デフォルト) すべてのサービスへの読み取り専用アクセス。 |
| services.read.list | array | サービスオブジェクトの配列。 指定されたサービス（子サービスを含む）に対して、ユーザーロールに読み取り専用アクセスが付与されます。読み取り専用アクセスは、サービスへの読み書きアクセスを上書きしません。 プロパティの動作: - services.read.modeが"0"に設定されている場合にサポート |
| services.read.tag | object | サービスタグオブジェクトの配列。 タグで一致したサービス（子サービスを含む）に対して、ユーザーロールに読み取り専用アクセスが付与されます。読み取り専用アクセスは、サービスへの読み書きアクセスを上書きしません。 プロパティの動作: - services.read.modeが"0"に設定されている場合にサポート |
| services.write.mode | integer | サービスへの読み書きアクセス。 可能な値: 0 - (デフォルト) services.write.listで指定された、またはservices.write.tagで一致したサービスへの読み書きアクセス;1 - すべてのサービスへの読み書きアクセス。 |
| services.write.list | array | サービスオブジェクトの配列。 指定されたサービス（子サービスを含む）に対して、ユーザーロールに読み書きアクセスが付与されます。読み書きアクセスは、サービスへの読み取り専用アクセスを上書きします。 プロパティの動作: - services.write.modeが"0"に設定されている場合にサポート |
| services.write.tag | object | サービスタグオブジェクトの配列。 タグで一致したサービス（子サービスを含む）に対して、ユーザーロールに読み書きアクセスが付与されます。読み書きアクセスは、サービスへの読み取り専用アクセスを上書きします。 プロパティの動作: - services.write.modeが"0"に設定されている場合にサポート |
| modules | array | モジュールオブジェクトの配列。 |
| modules.default_access | integer | 新しいモジュールへのアクセスが有効かどうか。 可能な値: 0 - 無効; 1 - (デフォルト) 有効。 |
| api.access | integer | APIへのアクセスが有効かどうか。 可能な値: 0 - 無効; 1 - (デフォルト) 有効。 |
| api.mode | integer | apiプロパティにリストされたAPIメソッドの扱いモード。可能な値: 0 - (デフォルト) 拒否リスト; 1 - 許可リスト。 |
| api | array | APIメソッドの配列。 |
| actions | array | アクションオブジェクトの配列。 |
| actions.default_access | integer | 新しいアクションへのアクセスが有効かどうか。 可能な値: 0 - 無効; 1 - (デフォルト) 有効。 |
UIエレメント
UIエレメントオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| name | string | UIエレメントの名前。 Roleオブジェクトの typeが「User」、「Admin」または「Super admin」に設定されている場合の値: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。Roleオブジェクトの typeが「Admin」または「Super admin」に設定されている場合の値:monitoring.discovery - 監視 → ディスカバリ;services.sla - サービス → SLA;reports.scheduled_reports - レポート → スケジュールレポート;reports.notifications - レポート → 通知;configuration.template_groups - データ収集 → テンプレートグループ;configuration.host_groups - データ収集 → ホストグループ;configuration.templates - データ収集 → テンプレート;configuration.hosts - データ収集 → ホスト;configuration.maintenance - データ収集 → メンテナンス;configuration.discovery - データ収集 → ディスカバリ;configuration.trigger_actions - アラート → アクション → トリガーアクション;configuration.service_actions - アラート → アクション → サービスアクション;configuration.discovery_actions - アラート → アクション → ディスカバリアクション;configuration.autoregistration_actions - アラート → アクション → 自動登録アクション;configuration.internal_actions - アラート → アクション → 内部アクション。Roleオブジェクトの typeが「Super admin」に設定されている場合の値:reports.system_info - レポート → システム情報;reports.audit - レポート → 監査ログ;reports.action_log - レポート → アクションログ;configuration.event_correlation - データ収集 → イベント相関;administration.media_types - アラート → メディアタイプ;administration.scripts - アラート → スクリプト;administration.user_groups - ユーザー → ユーザーグループ;administration.user_roles - ユーザー → ユーザーロール;administration.users - ユーザー → ユーザー;administration.api_tokens - ユーザー → APIトークン;administration.authentication - ユーザー → 認証;administration.general - 管理 → 一般;administration.audit_log - 管理 → 監査ログ;administration.housekeeping - 管理 → ハウスキーピング;administration.proxy_groups - 管理 → プロキシグループ;administration.proxies - 管理 → プロキシ;administration.macros - 管理 → マクロ;administration.queue - 管理 → キュー。プロパティの動作: - 必須 |
| status | integer | UIエレメントへのアクセスが有効かどうか。 可能な値: 0 - 無効; 1 - (デフォルト) 有効。 |
サービス
サービスタグ
| プロパティ | タイプ | 説明 |
|---|---|---|
| tag | string | タグ名。 空文字列を指定した場合、サービスタグはサービスのマッチングに使用されません。 プロパティの動作: - 必須 |
| value | string | タグ値。 値が指定されていないか空文字列が指定されている場合、タグ名のみがサービスのマッチングに使用されます。 |
モジュール
モジュールオブジェクトは以下のプロパティを持ちます。
| プロパティ | タイプ | 説明 |
|---|---|---|
| moduleid | ID | モジュールのID。 プロパティの動作: - 必須 |
| status | integer | モジュールへのアクセスが有効かどうか。 可能な値: 0 - 無効; 1 - (デフォルト) 有効。 |
アクション
アクションオブジェクトには以下のプロパティがあります。
| プロパティ | タイプ | 説明 |
|---|---|---|
| name | string | アクションの名前。 ロールオブジェクトの typeが"User"、"Admin"、"Super admin"に設定されている場合の値:edit_dashboards - ダッシュボードの作成と編集;edit_maps - マップの作成と編集;add_problem_comments - 障害コメントの追加;change_severity - 障害の深刻度の変更;acknowledge_problems - 障害の確認;suppress_problems - 障害の抑制;close_problems - 障害のクローズ;execute_scripts - スクリプトの実行;manage_api_tokens - APIトークンの管理;edit_own_media - 自分のメディアの作成/編集を許可。ロールオブジェクトの typeが"Admin"または"Super admin"に設定されている場合の値:edit_maintenance - メンテナンスの作成と編集;manage_scheduled_reports - スケジュールレポートの管理,manage_sla - SLAの管理。ロールオブジェクトの typeが"User"または"Admin"に設定されている場合の値:invoke_execute_now - ホストに対して読み取り権限のみを持つユーザーがアイテムチェックを実行できるようにします。ロールオブジェクトの typeが"Super admin"に設定されている場合の値:edit_user_media - ユーザーのメディアの作成/編集を許可。プロパティの動作: - 必須 |
| status | integer | アクションの実行権限が有効かどうか。 可能な値: 0 - 無効; 1 - (デフォルト) 有効。 |