- FutureNet製品活用ガイド
- FutureNet NXR,VXRシリーズ
- REST-API編
FutureNet
NXR,VXRシリーズ
REST-API編
8. 各種サービス設定
8-9. Web認証設定（web-auth）
処理概要
Web認証設定に関する処理を実行します。
URIおよびメソッド
| 機能 | Version | URI | メソッド | |||
| POST | PUT | GET | DELETE | |||
| Web-Auth | v2 | /api/v2/web-auth | 〇 | 〇 | ● | 〇 |
| /api/v2/web-auth-ext | － | － | － | － | ||
| /api/v2/web-auth-ext/network | 〇 | － | ● | － | ||
| /api/v2/web-auth-ext/network/{INDEX} | － | 〇 | ● | 〇 | ||
凡例：
● : 読み取り専用ユーザも含めアクセス可
〇 : 読み取り専用ユーザはアクセス不可
－ : 未対応
実行例
Web認証設定の作成
| メソッド | URI |
| POST | /api/v2/web-auth |
JSON
リクエスト
POST /api/v2/web-auth
Content-Type: application/json
{
"authenticate": {
"type": "basic"
},
"monitor": {
"port": 80
},
"close": {
"type": "idle-timeout",
"value": 600
},
"log": "enable",
"account-user": {
"username": "test",
"password": {
"passphrase": "testpass"
}
}
}
レスポンス
http-serverのrestartが伴うため、エラー表示になる場合があります。そのため、設定の反映状況は、GETメソッドで確認してください。
XML
リクエスト
POST /api/v2/web-auth
Content-Type: application/xml
<web-auth>
<authenticate>
<type>basic</type>
</authenticate>
<monitor>
<port>80</port>
</monitor>
<close>
<type>idle-timeout</type>
<value>600</value>
</close>
<log>enable</log>
<account-user>
<username>test</username>
<password>
<passphrase>testpass</passphrase>
</password>
</account-user>
</web-auth>
レスポンス
http-serverのrestartが伴うため、エラー表示になる場合があります。そのため、設定の反映状況は、GETメソッドで確認してください。
Web認証設定の更新
| メソッド | URI |
| PUT | /api/v2/web-auth |
JSON
リクエスト
PUT /api/v2/web-auth
Content-Type: application/json
{
"authenticate": {
"type": "basic"
},
"monitor": {
"port": 80,
"redirect": "enable"
},
"redirect-url": "http://www.centurysys.co.jp",
"close": {
"type": "idle-timeout",
"value": 600
},
"log": "enable",
"account-user": {
"username": "test",
"password": {
"passphrase": "testpass"
}
}
}
レスポンス
http-serverのrestartが伴うため、エラー表示になる場合があります。そのため、設定の反映状況は、GETメソッドで確認してください。
XML
リクエスト
PUT /api/v2/web-auth
Content-Type: application/xml
<web-auth>
<authenticate>
<type>basic</type>
</authenticate>
<monitor>
<port>80</port>
<redirect>enable</redirect>
</monitor>
<redirect-url>http://www.centurysys.co.jp</redirect-url>
<close>
<type>idle-timeout</type>
<value>600</value>
</close>
<log>enable</log>
<account-user>
<username>test</username>
<password>
<passphrase>testpass</passphrase>
</password>
</account-user>
</web-auth>
レスポンス
http-serverのrestartが伴うため、エラー表示になる場合があります。そのため、設定の反映状況は、GETメソッドで確認してください。
Web認証設定の取得
| メソッド | URI |
| GET | /api/v2/web-auth |
JSON
リクエスト
GET /api/v2/web-auth
Accept: application/json
レスポンス
200 OK
Content-Type: application/json
{
"authenticate": {
"type": "basic"
},
"monitor": {
"port": 80,
"redirect": "enable"
},
"redirect-url": "http://www.centurysys.co.jp",
"close": {
"type": "idle-timeout",
"value": 600
},
"log": "enable",
"account-user": {
"username": "test",
"password": {
"passphrase": "testpass"
}
}
}
XML
リクエスト
GET /api/v2/web-auth
Accept: application/xml
レスポンス
200 OK
Content-Type: application/xml
<web-auth>
<authenticate>
<type>basic</type>
</authenticate>
<monitor>
<port>80</port>
<redirect>enable</redirect>
</monitor>
<redirect-url>http://www.centurysys.co.jp</redirect-url>
<close>
<type>idle-timeout</type>
<value>600</value>
</close>
<log>enable</log>
<account-user>
<username>test</username>
<password>
<passphrase>testpass</passphrase>
</password>
</account-user>
</web-auth>
TEXT/PLAIN
リクエスト
GET /api/v2/web-auth
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
web-authenticate
authenticate basic
monitor port 80 redirect
redirect-url http://www.centurysys.co.jp
close idle-timeout 600
log enable
account username test password testpass
Web認証設定の削除
| メソッド | URI |
| DELETE | /api/v2/web-auth |
リクエスト
DELETE /api/v2/web-auth
レスポンス
204 No content
Web認証拡張設定の作成
| メソッド | URI |
| POST | /api/v2/web-auth-ext/network |
JSON
リクエスト
POST /api/v2/web-auth-ext/network
Content-Type: application/json
{
"network": {
"index": 1,
"prefix": "192.168.0.0/24",
"url": {
"redirect-url": "http://www.centurysys.co.jp"
}
}
}
レスポンス
201 Created
XML
リクエスト
POST /api/v2/web-auth-ext/network
Content-Type: application/xml
<web-auth-ext>
<network>
<index>1</index>
<prefix>192.168.0.0/24</prefix>
<url>
<redirect-url>http://www.centurysys.co.jp</redirect-url>
</url>
</network>
</web-auth-ext>
レスポンス
201 Created
全Web認証拡張設定の取得
| メソッド | URI |
| GET | /api/v2/web-auth-ext/network |
JSON
リクエスト
GET /api/v2/web-auth-ext/network
Accept: application/json
レスポンス
200 OK
Content-Type: application/json
{
"network": [
{
"index": 1,
"prefix": "192.168.0.0/24",
"url": {
"redirect-url": "http://www.centurysys.co.jp"
}
},
{
"index": 2,
・・・・・
XML
リクエスト
GET /api/v2/web-auth-ext/network
Accept: application/xml
レスポンス
200 OK
Content-Type: application/xml
<web-auth-ext>
<network>
<index>1</index>
<prefix>192.168.0.0/24</prefix>
<url>
<redirect-url>http://www.centurysys.co.jp</redirect-url>
</url>
</network>
<network>
<index>2</index>
・・・・・
TEXT/PLAIN
リクエスト
GET /api/v2/web-auth-ext/network
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
web-auth-extension 1
network 192.168.0.0/24
redirect-url http://www.centurysys.co.jp
web-auth-extension 2
・・・・・
Web認証拡張設定の更新
| メソッド | URI |
| PUT | /api/v2/web-auth-ext/network/{INDEX} |
JSON
リクエスト
PUT /api/v2/web-auth-ext/network/1
Content-Type: application/json
{
"index": 1,
"prefix": "192.168.0.0/24",
"url": {
"access-url": "http://access.example.jp",
"redirect-url": "http://www.centurysys.co.jp"
},
"radius": {
"server": {
"address": "192.168.2.1",
"password": {
"passphrase": "passwd"
}
}
}
}
レスポンス
204 No content
XML
リクエスト
PUT /api/v2/web-auth-ext/network/1
Content-Type: application/xml
<network>
<index>1</index>
<prefix>192.168.0.0/24</prefix>
<url>
<access-url>http://access.example.jp</access-url>
<redirect-url>http://www.centurysys.co.jp</redirect-url>
</url>
<radius>
<server>
<address>192.168.2.1</address>
<password>
<passphrase>passwd</passphrase>
</password>
</server>
</radius>
</network>
レスポンス
204 No content
Web認証拡張設定の取得
| メソッド | URI |
| GET | /api/v2/web-auth-ext/network/{INDEX} |
JSON
リクエスト
GET /api/v2/web-auth-ext/network/1
Accept: application/json
レスポンス
200 OK
Content-Type: application/json
{
"index": 1,
"prefix": "192.168.0.0/24",
"url": {
"access-url": "http://access.example.jp",
"redirect-url": "http://www.centurysys.co.jp"
},
"radius": {
"server": {
"address": "192.168.2.1",
"password": {
"passphrase": "passwd"
}
}
}
}
XML
リクエスト
GET /api/v2/web-auth-ext/network/1
Accept: application/xml
レスポンス
200 OK
Content-Type: application/xml
<network>
<index>1</index>
<prefix>192.168.0.0/24</prefix>
<url>
<access-url>http://access.example.jp</access-url>
<redirect-url>http://www.centurysys.co.jp</redirect-url>
</url>
<radius>
<server>
<address>192.168.2.1</address>
<password>
<passphrase>passwd</passphrase>
</password>
</server>
</radius>
</network>
TEXT/PLAIN
リクエスト
GET /api/v2/web-auth-ext/network/1
Accept: text/plain
レスポンス
200 OK
Content-Type: text/plain
web-auth-extension 1
network 192.168.0.0/24
access-url http://access.example.jp
redirect-url http://www.centurysys.co.jp
radius 192.168.2.1 password passwd
Web認証拡張設定の削除
| メソッド | URI |
| DELETE | /api/v2/web-auth-ext/network/{INDEX} |
リクエスト
DELETE /api/v2/web-auth-ext/network/1
レスポンス
204 No content
パラメータ
指定可能なパラメータは下記の通りです。
なお、指定可能なパラメータは製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については各製品のユーザーズガイド（CLI版）も合わせてご参照ください。
- パラメータ表の説明文中の記号について
< > … 括弧内の値の範囲から選択することを示しています。
[ ] … 括弧内の値のどれかを選択することを示しています。
数字,文字列 … 初期値 - パラメータ表の説明文中のデータタイプについて
A.B.C.D … IPv4アドレス
A.B.C.D/M … IPv4プレフィックスおよびマスク長
X:X::X:X … IPv6アドレス
X:X::X:X/M … IPv6プレフィックスおよびプレフィックス長
XX:XX:XX:XX:XX:XX … MACアドレス
web-auth
| パラメータおよびレベル | 説明 | ||||
|---|---|---|---|---|---|
| Lv.1 | Lv.2 | Lv.3 | Lv.4 | Lv.5 | |
| web-auth | authenticate | type | 認証タイプ … [ basic | post-ext-html | post-ext-xml ] | ||
| redirect | Web認証後のURL転送 … [ enable | disable ] | ||||
| monitor | port | モニタ対象ポート …
※443のみの指定不可 |
|||
| redirect | モニタ後のURL転送 … [ enable | disable ] | ||||
| redirect-url | 転送先URL | ||||
| close | type | 終了タイプ … [ browser-close | idle-timeout | session-timeout | idle-session-timeout ] | |||
| value | 接続許可時間 … <60-2592000(1800)> ※idle-session-timeout指定時は、idle,session用に二つ指定 |
||||
| log | 認証ログ … [ enable | disable ] |
||||
| account-authenticate | 認証方法 … [ local | radius | radius-and-local ] | ||||
| account-user | username | ユーザ名 | |||
| password | hidden | 暗号化 … [ enable | disable ] | |||
| passphrase | パスワード | ||||
| apply | 暗号化適用 … [ enable | disable ] ※hidden化する場合は必要 |
||||
| radius | server | address | RADIUSサーバアドレス …
|
||
| password | hidden | 暗号化 … [ enable | disable ] | |||
| passphrase | パスワード | ||||
| apply | 暗号化適用 … [ enable | disable ] ※hidden化する場合は必要 |
||||
| auth-port | 認証ポート … [ 1645 | 1812 | <1024-65535> ] | ||||
| attribute | type | アトリビュートタイプ … [ nas-identifier | nas-ip-address | nas-ipv6-address ] | |||
| value | アトリビュート値 …
|
||||
| idle-timeout | idle-timeoutアトリビュート … [ idle-timeout | ascend-idle-limit | ascend-idle-limit-vsa ] | ||||
| session-timeout | session-timeoutアトリビュート … [ session-timeout | ascend-maximum-time | ascend-maximum-time-vsa ] |
||||
| mac-access-list | mac-address | MACアドレス … XX:XX:XX:XX:XX:XX | |||
| permission | 動作 … [ permit | deny ] | ||||
| interface | 受信インタフェース … インタフェース名（ex. ethernet0） | ||||
| use-https | HTTPSの利用 … [ enable | disable ] | ||||
| access-path | path | アクセスパスの指定 | |||
| wispr-success-url | url | WISPr URL | |||
| reply | リプライ … no-content | ||||
web-auth-ext
| パラメータおよびレベル | 説明 | |||||
|---|---|---|---|---|---|---|
| Lv.1 | Lv.2 | Lv.3 | Lv.4 | Lv.5 | Lv.6 | |
| web-auth-ext | network | index | インデックス番号 | |||
| prefix | ネットワーク …
|
|||||
| account-authenticate | アカウント認証方法 … [ disable | none | radius ] |
|||||
| radius | server | address | RADIUSサーバアドレス …
|
|||
| password | hidden | 暗号化 … [ enable | disable ] | ||||
| passphrase | パスワード | |||||
| apply | 暗号化適用 … [ enable | disable ] ※hidden化する場合は必要 |
|||||
| auth-port | 認証ポート … [ 1645 | 1812 | <1024-65535> ] | |||||
| attribute | type | アトリビュートタイプ … [ chap-password | nas-identifier | nas-ip-address | nas-ipv6-address ] | ||||
| value | アトリビュート値 …
|
|||||
| idle-timeout | idle-timeoutアトリビュート … [ idle-timeout | ascend-idle-limit | ascend-idle-limit-vsa ] | |||||
| session-timeout | session-timeoutアトリビュート … [ session-timeout | ascend-maximum-time | ascend-maximum-time-vsa ] | |||||
| url | redirect-url | 転送先URL | ||||
| access-url | 認証成功時の転送先URL |
|||||
| failure-url | 認証失敗時の転送先URL | |||||
| receive-option | permit-source | POST受信ネットワークアドレス …
|
||||
| password | hidden | 暗号化 … [ enable | disable ] | ||||
| passphrase | パスワード | |||||
| apply | 暗号化適用 … [ enable | disable ] ※hidden化する場合は必要 |
|||||
| idle-timeout | idle-timeout … [ enable | disable ] | |||||
| session-timeout | session-timeout … [ enable | disable ] | |||||
目次
- 1. REST-API機能の利用方法およびAuth-IDの発行
- 2. メンテナンス
- 3. インタフェース設定
- 4. ルーティング設定
- 5. アクセスリスト設定
- 6. NAT設定
- 7. VPN設定
- 8. 各種サービス設定
- 各種サービス設定一覧
- 8-1. IPv4DHCPサーバ設定（dhcp-server）
- 8-2. DNS設定（dns）
- 8-3. NTP設定（ntp）
- 8-4. SNMP設定（snmp）
- 8-5. シスログ設定（syslog）
- 8-6. UPnP設定（upnp）
- 8-7. スケジュール設定（scheduler）
- 8-8. WarpLink設定（warplink）
- 8-9. Web認証設定（web-auth）
- 8-10. ターミナルサーバ設定（terminal-server）
- 8-11. SSHサーバ設定（ssh）
- 8-12. TELNETサーバ設定（telnet）
- 8-13. HTTPサーバ設定（http）
- 8-14. CMSv2設定（cms）
- 8-15. DNSインターセプト設定（dns-intercept）
- 8-16. DDNS設定（ddns）
- 8-17. DHCPリレー設定（dhcp-relay）
- 8-18. DHCPv6クライアント設定（dhcp6-client）
- 8-19. DHCPv6サーバ設定（dhcp6-server）
- 8-20. メール設定（mail）
- 8-21. SSLトンネル設定（ssl）
- 8-22. モニタログ設定（monitor-log）
- 8-23. SIP-NAT設定（sip-nat）
- 8-24. NGN-SIP設定（ngn-sip）
- 8-25. Wake ON LAN設定（wol）
- 8-26. DIO設定（dio）
- 8-27. speed-test設定（speed-test）
- 8-28. リバースSSHトンネル設定（reverse-ssh）
- 8-29. QoS設定（qos）
- 9. ネットイベント設定
- 10. モバイル・WiFi設定
- 11. IPv4/IPv6設定
- 12. システム設定
更新情報
→ 一覧へカテゴリ
タグ
- CRG
- DDNS
- DHCP
- DNAT
- DNSインターセプト
- Ethernet
- IIJモバイル
- IKE Modeconfig
- IKEv2 Configuration Payload
- IPinIP
- IPoE
- IPv6
- KDDI
- L2TPv3
- MAP-E
- NGN
- NTTドコモ
- PBR
- Policy Based IPsec
- PPP
- PPPoE
- QoS
- RADIUS連携
- RAシリーズ
- Route Based IPsec
- SMS
- SNAT
- SoftBank
- UPnP
- URL転送
- VLAN
- VRRP
- Web認証
- WiMAX
- コンフィグロールバック
- ネットイベント
- フィルタ
- ブリッジ
- モニタログ
- ワイモバイル
- 仮想スイッチ
- 冗長化
- 無線LAN