Roleオブジェクト

次のオブジェクトは、roleAPIに直接関連しています。

ロール

ロールオブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
roleid ID ロールのID。

Property behavior:
- read-only
- 更新操作で required
name string ロール名。

Property behavior:
- 作成操作で required
type integer ユーザータイプ。

指定可能な値:
1 - (default) ユーザー;
2 - 管理者;
3 - 特権管理者。

Property behavior:
- 作成操作で required
readonly integer ロールが読み取り専用かどうか。

指定可能な値:
0 - (default) いいえ;
1 - はい。

Property behavior:
- read-only

ロールルール

ロールルールオブジェクトには、以下のプロパティがあります。

プロパティ 型 説明
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 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要素

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 - レポート → トリガー top 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 - (デフォルト) 有効。

サービス

プロパティ Type 説明
serviceid ID サービスのID。

プロパティの動作:
- 必須

サービスタグ

プロパティ Type 説明
tag string タグ名。

空文字列が指定された場合、サービスタグはサービスのマッチングに使用されません。

プロパティの動作:
- 必須
value string タグ値。

値が指定されていない場合、または空文字列が指定された場合、サービスのマッチングにはタグ名のみが使用されます。

モジュール

モジュールオブジェクトには、以下のプロパティがあります。

プロパティ Type 説明
moduleid ID モジュールのID。

プロパティの動作:
- 必須
status integer モジュールへのアクセスが有効かどうか。

指定可能な値:
0 - 無効;
1 - (デフォルト) 有効。

アクション

アクションオブジェクトには以下のプロパティがあります。

プロパティ 型 説明
name string アクションの名前。

Role オブジェクトの 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トークンの管理;
change_problem_ranking - 障害の順位付けを原因から症状へ、またはその逆に変更;
edit_own_media - 自身のメディアの作成/編集を許可。

Role オブジェクトの type が "Admin" または "Super admin" に設定されている場合の使用可能な値:
edit_maintenance - メンテナンスの作成と編集;
manage_scheduled_reports - スケジュールレポートの管理,
manage_sla - SLAの管理。

Role オブジェクトの type が "User" または "Admin" に設定されている場合の使用可能な値:
invoke_execute_now - ホストに対して読み取り権限のみを持つユーザーによるアイテムチェックの実行を許可。

Role オブジェクトの type が "Super admin" に設定されている場合の使用可能な値:
edit_user_media - ユーザーのメディアの作成/編集を許可。

プロパティの動作:
- 必須
status integer アクションの実行アクセスが有効かどうか。

使用可能な値:
0 - 無効;
1 - (デフォルト) 有効。