contacts オブジェクト

contactsオブジェクトは、X-MONのユーザ設定を操作するオブジェクトです。

メソッド一覧

contacts.addユーザ設定の新規作成

contacts.addは、ユーザ設定を新規作成するためのメソッドです。

対応X-MONバージョン	3.0.9 以降
必要ユーザ権限	システム管理者運用責任者オペレータ閲覧者通知ユーザ

オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。

リクエストパラメータ

カラム名称	型	概要
contact_name 必須	string	ユーザIDを指定します。
alias	string	ユーザの名称を指定します。省略時には、contact_nameと同じ値が指定されます。
passwd	string	ユーザのパスワードを指定します。
acl	string	ユーザの権限を指定します。 admin 管理者権限 senior 運用責任者権限 operator オペレータ権限 visitor 閲覧者権限 notify 通知ユーザ省略時には、visitorが指定されます。
host_notifications_enabled	boolean	ホスト通知の有効化を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
service_notifications_enabled	boolean	サービス通知の有効化を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
host_notification_options	object	ホスト通知対象を指定します。 up ステータスUPの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする down ステータスDOWNの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする unreachable ステータスUNREACHABLEの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする flap フラップ通知を有効にするかどうかを指定します。 true 有効にする false 無効にする downtime ダウンタイムの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする省略時には、ステータス「UP」「DOWN」「UNREACHABLE」の通知のみが有効になります。
service_notification_options	object	サービス通知対象を指定します。 ok ステータスOKの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする critical ステータスCRITICALの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする warning ステータスWARNINGの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする unknown ステータスUNKNOWNの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする flap フラップ通知を有効にするかどうかを指定します。 true 有効にする false 無効にする downtime ダウンタイムの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする省略時には、ステータス「OK」「CRITICAL」「WARNING」「UNKNOWN」の通知のみが有効になります。
email	string	通知先のE-MAILアドレスを指定します。
pager	string	通知先の携帯モバイル用E-MAILアドレスを指定します。
retain_status_information	boolean	ステータス情報の保持を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
retain_nonstatus_information	boolean	非ステータス情報の保持を指定します。 true 有効にする false 無効にする省略時には、trueが指定されます。
view	array	閲覧対象ホストグループを指定します。閲覧を許可するホストグループIDを指定してください。以下の場合、制限なしとなります。空配列 #allを含む配列 null 対象ユーザが閲覧者権限以外
address1	string	Twilio連携に使用する電話番号を指定します。 +81 といった国別コードを付与した電話番号を記載してください。
approve	boolean	このリクエストを即座に反映するかどうかを指定します。省略時には、trueの指定となり、即座に反映されます。
authentication_method 3.1.0 以降	string	認証方式を指定します。 local ローカル認証 ldap LDAP サーバ認証 no_login ログインを許可しない省略時には、localが指定されます。また、ユーザの権限が通知ユーザの場合、必ずno_loginに置き換わります。
ldap_server_id 3.1.0 以降	integer	LDAP サーバ ID を指定します。
ldap_server_user 3.1.0 以降	string	LDAP サーバ認証時に利用するLDAPサーバアカウントを指定します。
default_dashboard_id 3.5.0 以降	string	ユーザのデフォルトダッシュボードIDを指定します。ダッシュボードIDは、dashboard.getを実行し一覧よりご確認ください。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

contacts.existユーザ設定の存在確認

contacts.existは、指定したユーザ設定が存在するかを確認するためのメソッドです。

対応X-MONバージョン	3.0.9 以降
必要ユーザ権限	システム管理者運用責任者オペレータ閲覧者通知ユーザ

リクエストパラメータ

カラム名称	型	概要
contact_name 必須	string	ユーザIDを指定します。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

contacts.deleteユーザ設定の削除

contacts.deleteは、ユーザ設定を削除するためのメソッドです。

対応X-MONバージョン	3.0.9 以降
必要ユーザ権限	システム管理者運用責任者オペレータ閲覧者通知ユーザ

オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。

リクエストパラメータ

カラム名称	型	概要
contact_name 必須	string	ユーザIDを指定します。
approve	boolean	このリクエストを即座に反映するかどうかを指定します。省略時には、trueの指定となり、即座に反映されます。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。

contacts.getユーザ設定の取得

contacts.getは、ユーザ設定を取得するためのメソッドです。

対応X-MONバージョン	3.0.9 以降
必要ユーザ権限	システム管理者運用責任者オペレータ閲覧者通知ユーザ

リクエストパラメータ

カラム名称	型	概要
contact_name	string	取得するユーザを指定します。
key	string	検索するユーザ設定を指定します。空欄を指定した場合、全てのユーザ設定を取得します。
limit	integer	検索時に取得する件数を指定します。省略時は、全件が取得されます。
offset	integer	取得開始するユーザ設定の行数を指定します。省略時は、0が指定されます。

このメソッドは、contact_nameもしくはkeyのどちらかの指定が必要です。

レスポンスカラム

カラム名称	型	概要
id	string	内部管理用のID
contact_name	string	ユーザID
alias	string	ユーザの名称
acl	string	ユーザの権限 admin 管理者権限 senior 運用責任者権限 operator オペレータ権限 visitor 閲覧者権限 notify 通知ユーザ
host_notifications_enabled	boolean	ホスト通知の有効化 true 有効 false 無効
service_notifications_enabled	boolean	サービス通知の有効化 true 有効 false 無効
host_notification_options	array	ホスト通知対象 up ステータスUPの通知 true 有効 false 無効 down ステータスDOWNの通知 true 有効 false 無効 unreachable ステータスUNREACHABLEの通知 true 有効 false 無効 flap フラップ通知 true 有効 false 無効 downtime ダウンタイムの通知 true 有効 false 無効
service_notification_options	array	サービス通知対象 ok ステータスOKの通知 true 有効 false 無効 critical ステータスCRITICALの通知 true 有効 false 無効 warning ステータスWARNINGの通知 true 有効 false 無効 unknown ステータスUNKNOWNの通知 true 有効 false 無効 flap フラップ通知 true 有効 false 無効 downtime ダウンタイムの通知 true 有効 false 無効
email	string	通知先のE-MAILアドレス
pager	string	通知先の携帯モバイル用E-MAILアドレス
retain_status_information	boolean	ステータス情報の保持 true 有効 false 無効
retain_nonstatus_information	boolean	非ステータス情報の保持 true 有効 false 無効
view	array	閲覧対象のホストグループID 空配列の場合、制限なしとなります。
host_notification_commands	string	ホスト通知で使用される内部コマンド
service_notification_commands	string	サービス通知で使用される内部コマンド
address1	string	Twilio連携で使用される電話番号
address2	string	現在のX-MONでは使用されていない情報のため、空値が返されます。
address3	string	現在のX-MONでは使用されていない情報のため、空値が返されます。
address4	string	現在のX-MONでは使用されていない情報のため、空値が返されます。
address5	string	現在のX-MONでは使用されていない情報のため、空値が返されます。
address6	string	現在のX-MONでは使用されていない情報のため、空値が返されます。
contactgroups	string	現在のX-MONでは使用されていない情報のため、空値が返されます。
can_submit_commands	boolean	現在のX-MONでは使用されていない情報のため、常に1が返されます。
authentication_method 3.1.0 以降	string	認証方式 local ローカル認証 ldap LDAP サーバ認証 no_login ログインを許可しない
ldap_server_id 3.1.0 以降	string	LDAP サーバ
ldap_server_user 3.1.0 以降	string	LDAPサーバアカウント
default_dashboard_id 3.5.0 以降	string	デフォルトダッシュボードID
default_dashboard_title 3.5.0 以降	string	デフォルトダッシュボード名称

contacts.updateユーザ設定の更新

contacts.updateは、既存のユーザ設定を編集するためのメソッドです。

対応X-MONバージョン	3.0.9 以降
必要ユーザ権限	システム管理者運用責任者オペレータ閲覧者通知ユーザ

オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。

リクエストパラメータ

カラム名称	型	概要
contact_name 必須	string	ユーザIDを指定します。
alias	string	ユーザの名称を指定します。
passwd	string	ユーザのパスワードを指定します。
acl	string	ユーザの権限を指定します。 admin 管理者権限 senior 運用責任者権限 operator オペレータ権限 visitor 閲覧者権限 notify 通知ユーザ
host_notifications_enabled	boolean	ホスト通知の有効化を指定します。 true 有効にする false 無効にする
service_notifications_enabled	boolean	サービス通知の有効化を指定します。 true 有効にする false 無効にする
host_notification_options	object	ホスト通知対象を指定します。 up ステータスUPの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする down ステータスDOWNの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする unreachable ステータスUNREACHABLEの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする flap フラップ通知を有効にするかどうかを指定します。 true 有効にする false 無効にする downtime ダウンタイムの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする
service_notification_options	object	サービス通知対象を指定します。 ok ステータスOKの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする critical ステータスCRITICALの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする warning ステータスWARNINGの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする unknown ステータスUNKNOWNの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする flap フラップ通知を有効にするかどうかを指定します。 true 有効にする false 無効にする downtime ダウンタイムの通知を有効にするかどうかを指定します。 true 有効にする false 無効にする
email	string	通知先のE-MAILアドレスを指定します。
pager	string	通知先の携帯モバイル用E-MAILアドレスを指定します。
retain_status_information	boolean	ステータス情報の保持を指定します。 true 有効にする false 無効にする
retain_nonstatus_information	boolean	非ステータス情報の保持を指定します。 true 有効にする false 無効にする
view	array	閲覧対象ホストグループを指定します。閲覧を許可するホストグループIDを指定してください。以下の場合、制限なしとなります。空配列 #allを含む配列 null 対象ユーザが閲覧者権限以外
address1	string	Twilio連携に使用する電話番号を指定します。 +81 といった国別コードを付与した電話番号を記載してください。
approve	boolean	このリクエストを即座に反映するかどうかを指定します。省略時には、trueの指定となり、即座に反映されます。
authentication_method 3.1.0 以降	string	認証方式を指定します。 local ローカル認証 ldap LDAP サーバ認証 no_login ログインを許可しない省略時には、localが指定されます。また、ユーザの権限が通知ユーザの場合、必ずno_loginに置き換わります。
ldap_server_id 3.1.0 以降	integer	LDAP サーバ ID を指定します。
ldap_server_user 3.1.0 以降	string	LDAP サーバ認証時に利用するLDAPサーバアカウントを指定します。
default_dashboard_id 3.5.0 以降	string	ユーザのデフォルトダッシュボードIDを指定します。ダッシュボードIDは、dashboard.getを実行し一覧よりご確認ください。

レスポンスカラム

このメソッドは、実行結果が boolean型で返ってきます。