[comment]: # aside: 1

[comment]: # ({70c23b61-2135842b})
# Roleオブジェクト

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

[comment]: # ({/70c23b61-2135842b})

[comment]: # ({4c760d03-1708e020})
### ロール

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

|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|roleid|ID|ロールのID。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*<br>- 更新操作で *必須*|
|name|string|ロールの名前。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- 作成操作で *必須*|
|type|integer|ユーザータイプ。<br><br>指定可能な値:<br>1 - *(デフォルト)* ユーザー;<br>2 - 管理者;<br>3 - 特権管理者。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- 作成操作で *必須*|
|readonly|integer|ロールが読み取り専用かどうか。<br><br>指定可能な値:<br>0 - *(デフォルト)* いいえ;<br>1 - はい。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *読み取り専用*|

[comment]: # ({/4c760d03-1708e020})

[comment]: # ({28862318-8a9b3008})
### ロールルール

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

|Property|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|ui|array|[UI要素](object#ui-element)オブジェクトの配列。|
|ui.default\_access|integer|新しいUI要素へのアクセスを有効にするかどうか。<br><br>使用可能な値:<br>0 - 無効;<br>1 - *(デフォルト)* 有効。|
|services.read.mode|integer|サービスへの読み取り専用アクセス。<br><br>使用可能な値:<br>0 - `services.read.list`で指定された、または`services.read.tag`プロパティに一致したサービスへの読み取り専用アクセス;<br>1 - *(デフォルト)* すべてのサービスへの読み取り専用アクセス。|
|services.read.list|array|[Service](object#service)オブジェクトの配列。<br><br>指定されたサービスおよびその子サービスに対して、ユーザーロールに読み取り専用アクセスが付与されます。読み取り専用アクセスは、サービスへの読み書きアクセスを上書きしません。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- `services.read.mode`が"0"に設定されている場合に*サポート*されます|
|services.read.tag|object|[Service tag](object#service-tag)オブジェクトの配列。<br><br>タグに一致したサービスおよびその子サービスに対して、ユーザーロールに読み取り専用アクセスが付与されます。読み取り専用アクセスは、サービスへの読み書きアクセスを上書きしません。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- `services.read.mode`が"0"に設定されている場合に*サポート*されます|
|services.write.mode|integer|サービスへの読み書きアクセス。<br><br>使用可能な値:<br>0 - *(デフォルト)* `services.write.list`で指定された、または`services.write.tag`プロパティに一致したサービスへの読み書きアクセス;<br>1 - すべてのサービスへの読み書きアクセス。|
|services.write.list|array|[Service](object#service)オブジェクトの配列。<br><br>指定されたサービスおよびその子サービスに対して、ユーザーロールに読み書きアクセスが付与されます。読み書きアクセスは、サービスへの読み取り専用アクセスを上書きします。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- `services.write.mode`が"0"に設定されている場合に*サポート*されます|
|services.write.tag|object|[Service tag](object#service-tag)オブジェクトの配列。<br><br>タグに一致したサービスおよびその子サービスに対して、ユーザーロールに読み書きアクセスが付与されます。読み書きアクセスは、サービスへの読み取り専用アクセスを上書きします。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- `services.write.mode`が"0"に設定されている場合に*サポート*されます|
|modules|array|[module](object#module)オブジェクトの配列。|
|modules.default\_access|integer|新しいモジュールへのアクセスを有効にするかどうか。<br><br>使用可能な値:<br>0 - 無効;<br>1 - *(デフォルト)* 有効。|
|api.access|integer|APIへのアクセスを有効にするかどうか。<br><br>使用可能な値:<br>0 - 無効;<br>1 - *(デフォルト)* 有効。|
|api.mode|integer|`api`プロパティに一覧表示されたAPIメソッドの扱いを決定するモード。<br><br>使用可能な値:<br>0 - *(デフォルト)* 拒否リスト;<br>1 - 許可リスト。|
|api|array|APIメソッドの配列。|
|actions|array|[action](object#action)オブジェクトの配列。|
|actions.default\_access|integer|新しいアクションへのアクセスを有効にするかどうか。<br><br>使用可能な値:<br>0 - 無効;<br>1 - *(デフォルト)* 有効。|

[comment]: # ({/28862318-8a9b3008})

[comment]: # ({b7519b73-006cdfb5})
#### UI要素

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

|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|name|string|UI要素の名前。<br><br>[Role](#role) オブジェクトの `type` が "User"、"Admin"、または "Super admin" に設定されている場合の使用可能な値:<br>`monitoring.dashboard` - *ダッシュボード*;<br>`monitoring.problems` - *監視 → 障害*;<br>`monitoring.hosts` - *監視 → ホスト*;<br>`monitoring.latest_data` - *監視 → 最新データ*;<br>`monitoring.maps` - *監視 → マップ*;<br>`services.services` - *サービス → サービス*;<br>`services.sla_report` - *サービス → SLAレポート*;<br>`inventory.overview` - *インベントリ → 概要*;<br>`inventory.hosts` - *インベントリ → ホスト*;<br>`reports.availability_report` - *レポート → 可用性レポート*;<br>`reports.top_triggers` - *レポート → トリガー top 100*.<br><br>[Role](#role) オブジェクトの `type` が "Admin" または "Super admin" に設定されている場合の使用可能な値:<br>`monitoring.discovery` - *監視 → ディスカバリ*;<br>`services.sla` - *サービス → SLA*;<br>`reports.scheduled_reports` - *レポート → 定期レポート*;<br>`reports.notifications` - *レポート → 通知*;<br>`configuration.template_groups` - *データ収集 → テンプレートグループ*;<br>`configuration.host_groups` - *データ収集 → ホストグループ*;<br>`configuration.templates` - *データ収集 → テンプレート*;<br>`configuration.hosts` - *データ収集 → ホスト*;<br>`configuration.maintenance` - *データ収集 → メンテナンス*;<br>`configuration.discovery` - *データ収集 → ディスカバリ*;<br>`configuration.trigger_actions` - *アラート → アクション → トリガーアクション*;<br>`configuration.service_actions` - *アラート → アクション → サービスアクション*;<br>`configuration.discovery_actions` - *アラート → アクション → ディスカバリアクション*;<br>`configuration.autoregistration_actions` - *アラート → アクション → 自動登録アクション*;<br>`configuration.internal_actions` - *アラート → アクション → 内部アクション*.<br><br>[Role](#role) オブジェクトの `type` が "Super admin" に設定されている場合の使用可能な値:<br>`reports.system_info` - *レポート → システム情報*;<br>`reports.audit` - *レポート → 監査ログ*;<br>`reports.action_log` - *レポート → アクションログ*;<br>`configuration.event_correlation` - *データ収集 → イベント相関*;<br>`administration.media_types` - *アラート → メディアタイプ*;<br>`administration.scripts` - *アラート → スクリプト*;<br>`administration.user_groups` - *ユーザー → ユーザーグループ*;<br>`administration.user_roles` - *ユーザー → ユーザーロール*;<br>`administration.users` - *ユーザー → ユーザー*;<br>`administration.api_tokens` - *ユーザー → APIトークン*;<br>`administration.authentication` - *ユーザー → 認証*;<br>`administration.general` - *管理 → 一般*;<br>`administration.audit_log` - *管理 → 監査ログ*;<br>`administration.housekeeping` - *管理 → ハウスキーピング*;<br>`administration.proxy_groups` - *管理 → プロキシグループ*;<br>`administration.proxies` - *管理 → プロキシ*;<br>`administration.macros` - *管理 → マクロ*;<br>`administration.queue` - *管理 → キュー*.<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|status|integer|UI要素へのアクセスが有効かどうか。<br><br>使用可能な値:<br>0 - 無効;<br>1 - *(デフォルト)* 有効。|

[comment]: # ({/b7519b73-006cdfb5})

[comment]: # ({e891a8d2-ebf4bb3a})
#### サービス

|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|serviceid|ID|サービスのID。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|

[comment]: # ({/e891a8d2-ebf4bb3a})

[comment]: # ({62d78428-300e6d5b})
#### サービスタグ

|プロパティ|[Type](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|tag|string|タグ名。<br><br>空文字列が指定された場合、サービスタグはサービスのマッチングに使用されません。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|value|string|タグ値。<br><br>値が指定されていない場合、または空文字列が指定された場合、サービスのマッチングにはタグ名のみが使用されます。|

[comment]: # ({/62d78428-300e6d5b})

[comment]: # ({bdcf5af8-f70e75e9})
#### モジュール

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

|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|moduleid|ID|モジュールのID。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|status|integer|モジュールへのアクセスが有効かどうか。<br><br>使用可能な値:<br>0 - 無効;<br>1 - *(デフォルト)* 有効。|

[comment]: # ({/bdcf5af8-f70e75e9})

[comment]: # ({17265016-957a00bb})
#### アクション

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

|プロパティ|[型](/manual/api/reference_commentary#data-types)|説明|
|--|--|------|
|name|string|アクション名。<br><br>[Role](#role) オブジェクトの `type` が "User"、"Admin"、または "Super admin" に設定されている場合の指定可能な値:<br>`edit_dashboards` - ダッシュボードの作成と編集;<br>`edit_maps` - マップの作成と編集;<br>`add_problem_comments` - 障害コメントの追加;<br>`change_severity` - 障害の深刻度の変更;<br>`acknowledge_problems` - 障害の確認;<br>`suppress_problems` - 障害の抑制;<br>`close_problems` - 障害のクローズ;<br>`execute_scripts` - スクリプトの実行;<br>`manage_api_tokens` - APIトークンの管理;<br>`change_problem_ranking` - 障害の順位付けを原因から症状へ、またはその逆に変更;<br>`edit_own_media` - 自身のメディアの作成/編集を許可。<br><br>[Role](#role) オブジェクトの `type` が "Admin" または "Super admin" に設定されている場合の指定可能な値:<br>`edit_maintenance` - メンテナンスの作成と編集;<br>`manage_scheduled_reports` - 定期レポートの管理,<br>`manage_sla` - SLAの管理。<br><br>[Role](#role) オブジェクトの `type` が "User" または "Admin" に設定されている場合の指定可能な値:<br>`invoke_execute_now` - ホストに対して読み取り権限のみを持つユーザーがアイテムチェックを実行できるようにします。<br><br>[Role](#role) オブジェクトの `type` が "Super admin" に設定されている場合の指定可能な値:<br>`edit_user_media` - ユーザーのメディアの作成/編集を許可。<br><br>[プロパティの動作](/manual/api/reference_commentary#property-behavior):<br>- *必須*|
|status|integer|アクションの実行アクセスが有効かどうか。<br><br>指定可能な値:<br>0 - 無効;<br>1 - *(デフォルト)* 有効。|

[comment]: # ({/17265016-957a00bb})
