管理者ユーザー向けAPI利用の注意点
下記APIでは入力の際、ticketのユーザーが管理者(typeがadmin)である必要があります。
admin_settings/list_user
概要
ユーザー一覧を取得。
カテゴリ
管理者設定
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
user | ユーザー(※リスト) |
id_user | ユーザーID(数値) |
userid | ユーザーID(文字列) |
type | admin:管理者 normal:一般 |
id_vhost | グループID(type=normal時) |
vhostname | グループ名(type=normal時) |
permission_contents | コンテンツ編集権限(type=normal時) |
permission_report | レポート参照権限(type=normal時) |
permission_user | ユーザー/グループ管理(type=admin時) |
備考
ステータス
有効
admin_settings/modify_user
概要
ユーザーを編集。
カテゴリ
管理者設定
入力
クエリー
名前 | 値 |
---|---|
id_user | ユーザーID(数値) |
password | パスワード(省略可) |
id_vhost | グループID(type=normal時) (省略可) |
permission_contents | コンテンツ編集権限(type=normal時) (省略可) |
permission_report | レポート参照権限(type=normal時) (省略可) |
permission_user | ユーザー/グループ管理(type=admin時) (省略可) |
備考
ステータス
有効
admin_settings/create_user
概要
ユーザーを作成。
カテゴリ
管理者設定
入力
クエリー
名前 | 値 |
---|---|
userid | ユーザーID(文字列) |
password | パスワード |
type | admin:管理者 normal:一般 |
id_vhost | グループID(type=normal時) |
permission_contents | コンテンツ編集権限(type=normal時) |
permission_report | レポート参照権限(type=normal時) |
permission_user | ユーザー/グループ管理(type=admin時) |
備考
ステータス
有効
admin_settings/delete_user
概要
ユーザーを削除。
カテゴリ
管理者設定
入力
クエリー
名前 | 値 |
---|---|
id_user | ユーザーID(数値) |
備考
ステータス
有効
admin_settings/list_vhost
概要
グループ一覧を取得。
カテゴリ
管理者設定
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
vhost | グループ(※リスト) |
id_vhost | グループID |
name | グループ名 |
description | 説明文 |
備考
ステータス
有効
admin_settings/modify_vhost
概要
グループを編集。
カテゴリ
管理者設定
入力
クエリー
名前 | 値 |
---|---|
id_vhost | グループID |
name | グループ名(省略可) |
description | 説明文(省略可) |
備考
ステータス
有効
admin_settings/create_vhost
概要
グループを作成。
カテゴリ
管理者設定
入力
クエリー
名前 | 値 |
---|---|
name | グループ名 |
description | 説明文 |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
id_vhost | グループID |
備考
ステータス
有効
admin_settings/delete_vhost
概要
vhostを削除。
カテゴリ
管理者設定
入力
クエリー
名前 | 値 |
---|---|
id_vhost | グループID |
説明
ユーザーが含まれていると削除できない。
備考
ステータス
有効
admin_settings/list_allow_ip_address
概要
ホワイトリスト一覧を取得。
カテゴリ
管理者設定
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
ip_address | ユーザー(※リスト) |
ip | IPアドレス |
備考
ステータス
有効
admin_settings/add_allow_ip_address
概要
ホワイトリストを追加
カテゴリ
管理者設定
入力
クエリー
名前 | 値 |
---|---|
ip | IPアドレス(例:0.0.0.0) |
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
ip | IPアドレス |
備考
ステータス
有効
admin_settings/remove_allow_ip_address
概要
ホワイトリストから削除
カテゴリ
管理者設定
入力
クエリー
名前 | 値 |
---|---|
ip | IPアドレス(例:0.0.0.0) |
備考
ステータス
有効
admin_settings/list_locked_ip_address
概要
自動ロックリスト一覧を取得。
カテゴリ
管理者設定
出力
レスポンス内容
名前(要素名) | 値(要素の内容) |
---|---|
ip_address | ユーザー(※リスト) |
ip | IPアドレス |
備考
ステータス
有効
admin_settings/unlock_ip_address
概要
自動ロックを解除
カテゴリ
管理者設定
入力
クエリー
名前 | 値 |
---|---|
ip | IPアドレス(例:0.0.0.0) |
備考
ステータス
有効