contactgroupオブジェクトは、X-MONのユーザグループ設定を操作するオブジェクトです。
contactgroup.addは、ユーザグループ設定を新規作成するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| contactgroup_name 必須 | string |
ユーザグループIDを指定します。 |
| alias | string |
ユーザグループの名称を指定します。 省略時には、contactgroup_nameと同じ値が指定されます。 |
| members 必須 | array |
ユーザグループとして設定するユーザIDを指定します。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。
contactgroup.existは、指定したユーザグループ設定が存在するかを確認するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
| カラム名称 | 型 | 概要 |
|---|---|---|
| contactgroup_name 必須 | string |
ユーザグループIDを指定します。 |
このメソッドは、実行結果が boolean型で返ってきます。
contactgroup.deleteは、ユーザグループ設定を削除するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| contactgroup_name 必須 | string |
ユーザグループIDを指定します。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。
contactgroup.getは、ユーザグループ設定を取得するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
| カラム名称 | 型 | 概要 |
|---|---|---|
| contactgroup_name | string | 取得するユーザグループを指定します。 |
| key | string |
検索するユーザグループ設定を指定します。 空欄を指定した場合、全てのユーザグループ設定を取得します。 |
| limit | integer |
検索時に取得する件数を指定します。 省略時は、全件が取得されます。 |
| offset | integer |
取得開始するユーザグループ設定の行数を指定します。 省略時は、0が指定されます。 |
このメソッドは、contactgroup_nameもしくはkeyのどちらかの指定が必要です。
| カラム名称 | 型 | 概要 |
|---|---|---|
| id | string |
内部管理用のID |
| contactgroup_name | string |
ユーザグループID |
| alias | string |
ユーザグループの名称 |
| members | array |
ユーザグループに所属しているユーザID |
| contactgroup_members | array |
現在のX-MONでは使用されていない情報のため、空値が返されます。 |
contactgroup.updateは、既存のユーザグループ設定を編集するためのメソッドです。
| 対応X-MONバージョン |
|
|---|---|
| 必要ユーザ権限 |
|
オペレータ権限の場合、approveカラムを明示的にfalseとする必要があります。
| カラム名称 | 型 | 概要 |
|---|---|---|
| contactgroup_name 必須 | string |
ユーザグループIDを指定します。 |
| alias | string |
ユーザグループの名称を指定します。 |
| members | array |
ユーザグループとして設定するユーザIDを指定します。 |
| approve | boolean |
このリクエストを即座に反映するかどうかを指定します。 省略時には、trueの指定となり、即座に反映されます。 |
このメソッドは、実行結果が boolean型で返ってきます。