创建站点下交换机有线认证模板配置
典型场景
创建站点下交换机有线认证模板配置。
接口功能
页面功能:部署/设备部署/站点配置/站点配置/交换机/认证/有线认证/创建操作
创建站点下交换机有线认证模板配置。
接口约束
该接口支持租户下北向管理员(用户角色为“Open Api Operator”)访问,必须在用户会话建立后使用。
调用方法
POST
URI
/controller/campus/api/v1/lswauth/wired/{siteId}
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
siteId |
是 |
string |
36个字符。 |
- |
站点标识,UUID格式。 |
"fbde1c5d-5b94-49e3-a912-48641015e45c" |
请求参数
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
lswAuthConfigDto |
是 |
REFERENCE |
详细请参见表3。 |
交换机认证模板配置信息。 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
id |
否 |
string |
32~36个字符。 |
- |
认证模板标识,更新时必填。 |
"b90f8190e12f432395f34018309209c4" |
name |
是 |
string |
1~32个字符。 |
- |
认证模板名称 |
"abc" |
ssidName |
否 |
string |
1~32个字符。 |
- |
ssid名称,无线认证模板必填。 |
"abc" |
authMode |
是 |
int32 |
[0-10] |
- |
认证模式 1-portal 2-mac 3-portal+mac 4-1x 5-portal+1x 6-mac+1x 7-portal+mac+1x 8-psk微信扫码 10-psk+mac |
1 |
escapeStrategy |
是 |
int32 |
[0-2] |
- |
逃生策略 0 允许用户接入,不需要认证 1 允许已认证用户继续使用网络,不允许新用户接入 2 允许用户接入,不需要认证。使用自定义逃生策略 |
0 |
escapeStrategyId |
否 |
string |
32~36个字符。 |
- |
逃生策略标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
escapePolicyName |
否 |
string |
1~32个字符。 |
- |
逃生策略模板名称 |
"abc" |
apFreeAuthEnable |
否 |
boolean |
|
- |
使能端口下AP免认证 |
false |
forceDomainEnable |
否 |
boolean |
|
true |
强制域使能 |
true |
preAuthPrivilege |
否 |
REFERENCE |
详细请参见表4。 |
语音终端免认证,仅交换机有线认证支持 |
- |
|
authFailPrivilege |
否 |
REFERENCE |
详细请参见表5。 |
终端认证失败网络访问权限 |
- |
|
voiceDeviceNoAuth |
否 |
REFERENCE |
详细请参见表6。 |
终端预连接网络访问权限 |
- |
|
hasPermission |
否 |
boolean |
|
- |
是否有操作权限 |
false |
portalConfigDto |
否 |
REFERENCE |
详细请参见表7。 |
Portal配置,authMode为1/3/5/7时必填 |
- |
|
radiusConfigDto |
否 |
REFERENCE |
详细请参见表12。 |
Radius配置 |
- |
|
configName |
否 |
string |
0~20个字符。满足正则表达^[a-zA-Z0-9._-]{0,20}$。 |
- |
配置名称标识,不允许修改,修改场景传null时,保持原值不变 |
"abc" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
preAuthPrivilegeEnable |
否 |
boolean |
|
- |
开启终端预连接网络访问权限 |
false |
vlan |
否 |
int32 |
[1-4094] |
- |
vlan编号 |
1 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
authFailPrivilegeEnable |
否 |
boolean |
|
- |
开启终端认证失败网络访问权限 |
false |
vlan |
否 |
int32 |
[1-4094] |
- |
vlan编号 |
1 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
voiceDeviceNoAuthEnable |
否 |
boolean |
|
- |
使能语音终端免认证 |
false |
vlan |
否 |
int32 |
[1-4094] |
- |
vlan编号 |
1 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
pagePushMode |
是 |
int32 |
[0-2] |
- |
0 云平台内置 1 云平台中继 2 第三方 |
0 |
freeAuthEnable |
否 |
boolean |
|
- |
免认证开关 |
false |
freeAuthExpired |
否 |
int32 |
[1-365] |
- |
免认证有效期 |
10 |
freeAuthExpiredUnit |
否 |
string |
|
- |
免认证有效期单位 分钟 小时 天 |
"minute" |
internalPortalConfigDto |
否 |
REFERENCE |
详细请参见表8。 |
云平台内置认证配置,pagePushMode为0时必填 |
- |
|
relayPortalConfigDto |
否 |
REFERENCE |
详细请参见表10。 |
云平台中继认证配置,pagePushMode为1时必填 |
- |
|
thirdPortalConfigDto |
否 |
REFERENCE |
详细请参见表11。 |
第三方认证配置,pagePushMode为2时必填 |
- |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
portalProtocol |
否 |
int32 |
[0-1] |
- |
portal协议类型 0 HACA 1 Portal2.0。混合认证时默认Portal2.0协议类型。 |
0 |
pushProtocol |
否 |
int32 |
[0-1] |
- |
推送协议 0 https 1 http |
0 |
pushMethod |
是 |
int32 |
[0-1] |
- |
推送方式 0 快推 1 高级推 |
0 |
pushPageId |
否 |
string |
32~36个字符。 |
- |
推送页面标识。快速推送时,pushPageId必填。 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
pushPageName |
否 |
string |
1~128个字符。 |
- |
推送页面名称 |
"abc" |
ipv6Enable |
否 |
boolean |
|
- |
IPv6终端认证 开关 |
false |
accountingEnable |
否 |
boolean |
|
- |
计费开关 |
false |
accountingPeriod |
否 |
int32 |
[5-65535] |
- |
费上报周期 单位分钟 |
10 |
anonymousAuthEnable |
否 |
boolean |
|
- |
匿名认证 |
false |
normalAuthEnable |
否 |
boolean |
|
- |
普通用户名密码认证 |
false |
normalAccessConfigDto |
否 |
REFERENCE |
详细请参见表9。 |
普通用户名密码认证配置 |
- |
|
smsAuthEnable |
否 |
boolean |
|
- |
短信认证 |
false |
smsAccessConfigDto |
否 |
REFERENCE |
详细请参见表9。 |
短信认证配置 |
- |
|
weChatUrlAuthEnable |
否 |
boolean |
|
- |
微信链接认证 |
false |
weChatAuthEnable |
否 |
boolean |
|
- |
微信Portal一键认证 |
false |
|
||||||
twitterAuthEnable |
否 |
boolean |
|
- |
twitter认证 |
false |
sinaWeiboAuthEnable |
否 |
boolean |
|
- |
新浪微博认证 |
false |
qqAuthEnable |
否 |
boolean |
|
- |
QQ认证 |
false |
googleAuthEnable |
否 |
boolean |
|
- |
Google认证 |
false |
weComAuthEnable |
否 |
boolean |
|
- |
企业微信认证 |
false |
dingTalkEnable |
否 |
boolean |
|
- |
钉钉认证 |
false |
passcodeAuthEnable |
否 |
boolean |
|
- |
passcode认证 |
false |
oneKeyAuthEnable |
否 |
boolean |
|
- |
一键认证 |
false |
qrCodeAuthEnable |
否 |
boolean |
|
- |
公共二维码认证 |
false |
qrCodeRegisterEnable |
否 |
boolean |
|
false |
二维码审批认证 |
false |
emailAuthEnable |
否 |
boolean |
|
false |
邮箱认证 |
false |
masterPortalTemplateId |
否 |
string |
32~36个字符。 |
- |
主portal服务器模板标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
masterPortalTemplateName |
否 |
string |
1~32个字符。 |
- |
主portal服务器模板名称 |
"portal" |
slavePortalServerEnable |
否 |
boolean |
|
- |
portal备服务器开关 |
false |
slavePortalTemplateId |
否 |
string |
32~36个字符。 |
- |
备portal服务器模板标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
slavePortalTemplateName |
否 |
string |
1~32个字符。 |
- |
备portal服务器模板名称 |
"portal" |
|
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
registerEnable |
否 |
boolean |
|
- |
用户自注册开关 |
false |
userExpiredTime |
否 |
int32 |
[1-365] |
- |
用户有效期 |
10 |
userExpiredUnit |
否 |
string |
|
- |
用户有效期单位 分钟 小时 天 |
"day" |
passwdExpiredTime |
否 |
int32 |
[1-365] |
- |
密码有效期 |
10 |
passwdExpiredUnit |
否 |
string |
|
- |
密码有效期单位 分钟 小时 天 |
"minute" |
accessMaxNumber |
否 |
int32 |
[1-16] |
- |
最大接入终端数 |
5 |
userGroupId |
否 |
string |
32~36个字符。 |
- |
用户所属组标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
userGroupName |
否 |
string |
1~128个字符。 |
- |
用户所属组名称 |
"root" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
connectionMode |
是 |
int32 |
[0-1] |
- |
0 api 1 radius中继 |
0 |
pushProtocol |
是 |
int32 |
[0-1] |
- |
推送协议 0 https 1 http |
0 |
userNameKey |
否 |
string |
1~64个字符。 |
- |
用户名参数名称 |
"userName" |
passwordKey |
否 |
string |
1~64个字符。 |
- |
密码参数名称 |
"password" |
urlMatchMode |
否 |
int32 |
[0-1] |
- |
0 重定向url参数 1 重定向url地址 |
0 |
authSuccessUrlKey |
否 |
string |
0~256个字符。 |
- |
认证成功跳转URL参数名称 |
"authSuccessUrl" |
authFailUrlKey |
否 |
string |
0~256个字符。 |
- |
认证失败跳转URL参数名称 |
"authFailUrl" |
logoutSuccessUrlKey |
否 |
string |
0~256个字符。 |
- |
注销成功跳转URL参数名称 |
"logoutSuccessUrl" |
logoutFailUrlKey |
否 |
string |
0~256个字符。 |
- |
注销失败跳转URL |
"logoutFailUrl" |
logoutUrlKey |
否 |
string |
0~64个字符。 |
- |
注销页面URL参数名称 |
"logoutUrl" |
radiusRelayServerId |
否 |
string |
32~36个字符。 |
- |
RADIUS中继服务器标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
radiusRelayServerName |
否 |
string |
1~32个字符。 |
- |
RADIUS中继服务器名称 |
"radius" |
accountingEnable |
否 |
boolean |
|
- |
计费开关 |
false |
accountingPeriod |
否 |
int32 |
[5-65535] |
- |
费上报周期 单位分钟 |
10 |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
masterPortalTemplateId |
是 |
string |
32~36个字符。 |
- |
主portal服务器模板标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
masterPortalTemplateName |
是 |
string |
1~32个字符。 |
- |
主portal服务器模板名称 |
"portal" |
slavePortalServerEnable |
是 |
boolean |
|
- |
portal备服务器开关 |
false |
slavePortalTemplateId |
否 |
string |
32~36个字符。 |
- |
备portal服务器模板标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
slavePortalTemplateName |
否 |
string |
1~32个字符。 |
- |
备portal服务器模板名称 |
"portal" |
参数名称 |
必选 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|---|
radiusTemplateId |
是 |
string |
32~36个字符。 |
- |
radius服务器模板标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
radiusTemplateName |
是 |
string |
1~32个字符。 |
- |
radius服务器模板名称 |
"portal" |
terminalAccessMode |
否 |
string |
|
multi-authen |
有线口终端接入模式(单终端接入:single-terminal,单普通终端通过语音终端接入:single-voice-with-data,多终端分别认证接入:multi-authen,仅第一个终端需要认证接入:multi-share;默认为:多终端分别认证接入)。有线认证生效。 |
"multi-authen" |
macBypassEnable |
否 |
boolean |
|
- |
mac旁路认证开关。有线认证生效。 |
false |
macWhitelistEnable |
否 |
boolean |
|
- |
mac白名单开关。无线认证生效。 |
false |
autoReAuthEnable |
否 |
boolean |
|
- |
自动重认证开关。无线认证生效。 |
false |
autoReAuthTime |
否 |
int32 |
[30-7200] |
- |
自动重认证时间,单位秒。无线认证生效。 |
30 |
coaAndDMForNATEnable |
否 |
boolean |
|
- |
支持NAT场景CoA/DM |
false |
protocolOfMacAuth |
否 |
string |
|
- |
认证协议。仅MAC认证场景使用此字段,MAC认证时如果不填,则默认为chap。 |
"chap" |
triggerPackets |
否 |
array<string> |
0-5 个列表项。每个列表项
|
- |
触发认证报文类型。有线认证生效。MAC认证和1x认证必填 |
["dhcp"] |
realTime |
否 |
REFERENCE |
详细请参见表13。 |
实时计费配置 |
- |
|
iconnectAccessEnable |
否 |
boolean |
|
false |
iConnect终端接入开关,默认值为false,仅支持云杉交换机。 |
- |
请求示例
POST /controller/campus/api/v1/lswauth/wired/20ab206c-5f5f-4cb6-9090-05cda5e9727b HTTPS Host: 192.168.1.125:18002 Content-Type: application/json Accept: application/json Accept-Language: en-US X-ACCESS-TOKEN:CA48D152F6B19D84:637C38259E6974E17788348128A430FEE150E874752CE754B6BF855281219925 { "name":"test12132", "authMode":1, "escapeStrategy":0, "apFreeAuthEnable":false, "forceDomainEnable": true, "preAuthPrivilege":{ "preAuthPrivilegeEnable":false, "vlan":"" }, "authFailPrivilege":{ "authFailPrivilegeEnable":false, "vlan":"" }, "voiceDeviceNoAuth":{ "voiceDeviceNoAuthEnable":false }, "portalConfigDto":{ "pagePushMode":0, "freeAuthEnable":false, "internalPortalConfigDto":{ "portalProtocol":1, "pushMethod":0, "ipv6Enable":false, "accountingPeriod":null, "masterPortalTemplateId":"1a638aed-d4b3-44ed-aaf1-f69dd9c4cfa8", "masterPortalTemplateName":"fff", "slavePortalServerEnable":false, "authorRedirectUrlParamEnable":false, "pushPageId":"9012b661-1750-4338-b84d-8ecf672bb790", "normalAccessConfigDto":{ "registerEnable":false, "userExpiredTime":null } } }, "radiusConfigDto":{ "radiusTemplateId":"ba07ac68-ba8e-4aa8-b0d6-041813827802", "radiusTemplateName":"iae" } }
响应参数
返回状态码为201:创建认证模板成功,响应体参考LswAuthConfigResponse。
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
errcode |
string |
0~64个字符。 |
- |
错误码。 |
"0" |
errmsg |
string |
0~256个字符。 |
- |
错误信息。 |
"" |
data |
ARRAY_REFERENCE |
0-64个列表项,详细请参见表15。 |
返回消息体的具体信息 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
id |
string |
32~36个字符。 |
- |
认证模板标识,更新时必填。 |
"b90f8190e12f432395f34018309209c4" |
name |
string |
1~32个字符。 |
- |
认证模板名称 |
"abc" |
ssidName |
string |
1~32个字符。 |
- |
ssid名称,无线认证模板必填。 |
"abc" |
authMode |
int32 |
[0-10] |
- |
认证模式 1-portal 2-mac 3-portal+mac 4-1x 5-portal+1x 6-mac+1x 7-portal+mac+1x 8-psk微信扫码 10-psk+mac |
1 |
escapeStrategy |
int32 |
[0-2] |
- |
逃生策略 0 允许用户接入,不需要认证 1 允许已认证用户继续使用网络,不允许新用户接入 2 允许用户接入,不需要认证。使用自定义逃生策略 |
0 |
escapeStrategyId |
string |
32~36个字符。 |
- |
逃生策略标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
escapePolicyName |
string |
1~32个字符。 |
- |
逃生策略模板名称 |
"abc" |
apFreeAuthEnable |
boolean |
|
- |
使能端口下AP免认证 |
false |
forceDomainEnable |
boolean |
|
true |
强制域使能 |
true |
preAuthPrivilege |
REFERENCE |
详细请参见表16。 |
语音终端免认证,仅交换机有线认证支持 |
- |
|
authFailPrivilege |
REFERENCE |
详细请参见表17。 |
终端认证失败网络访问权限 |
- |
|
voiceDeviceNoAuth |
REFERENCE |
详细请参见表18。 |
终端预连接网络访问权限 |
- |
|
hasPermission |
boolean |
|
- |
是否有操作权限 |
false |
portalConfigDto |
REFERENCE |
详细请参见表19。 |
Portal配置,authMode为1/3/5/7时必填 |
- |
|
radiusConfigDto |
REFERENCE |
详细请参见表24。 |
Radius配置 |
- |
|
configName |
string |
0~20个字符。满足正则表达^[a-zA-Z0-9._-]{0,20}$。 |
- |
配置名称标识,不允许修改,修改场景传null时,保持原值不变 |
"abc" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
preAuthPrivilegeEnable |
boolean |
|
- |
开启终端预连接网络访问权限 |
false |
vlan |
int32 |
[1-4094] |
- |
vlan编号 |
1 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
authFailPrivilegeEnable |
boolean |
|
- |
开启终端认证失败网络访问权限 |
false |
vlan |
int32 |
[1-4094] |
- |
vlan编号 |
1 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
voiceDeviceNoAuthEnable |
boolean |
|
- |
使能语音终端免认证 |
false |
vlan |
int32 |
[1-4094] |
- |
vlan编号 |
1 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
pagePushMode |
int32 |
[0-2] |
- |
0 云平台内置 1 云平台中继 2 第三方 |
0 |
freeAuthEnable |
boolean |
|
- |
免认证开关 |
false |
freeAuthExpired |
int32 |
[1-365] |
- |
免认证有效期 |
10 |
freeAuthExpiredUnit |
string |
|
- |
免认证有效期单位 分钟 小时 天 |
"minute" |
internalPortalConfigDto |
REFERENCE |
详细请参见表20。 |
云平台内置认证配置,pagePushMode为0时必填 |
- |
|
relayPortalConfigDto |
REFERENCE |
详细请参见表22。 |
云平台中继认证配置,pagePushMode为1时必填 |
- |
|
thirdPortalConfigDto |
REFERENCE |
详细请参见表23。 |
第三方认证配置,pagePushMode为2时必填 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
portalProtocol |
int32 |
[0-1] |
- |
portal协议类型 0 HACA 1 Portal2.0。混合认证时默认Portal2.0协议类型。 |
0 |
pushProtocol |
int32 |
[0-1] |
- |
推送协议 0 https 1 http |
0 |
pushMethod |
int32 |
[0-1] |
- |
推送方式 0 快推 1 高级推 |
0 |
pushPageId |
string |
32~36个字符。 |
- |
推送页面标识。快速推送时,pushPageId必填。 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
pushPageName |
string |
1~128个字符。 |
- |
推送页面名称 |
"abc" |
ipv6Enable |
boolean |
|
- |
IPv6终端认证 开关 |
false |
accountingEnable |
boolean |
|
- |
计费开关 |
false |
accountingPeriod |
int32 |
[5-65535] |
- |
费上报周期 单位分钟 |
10 |
anonymousAuthEnable |
boolean |
|
- |
匿名认证 |
false |
normalAuthEnable |
boolean |
|
- |
普通用户名密码认证 |
false |
normalAccessConfigDto |
REFERENCE |
详细请参见表21。 |
普通用户名密码认证配置 |
- |
|
smsAuthEnable |
boolean |
|
- |
短信认证 |
false |
smsAccessConfigDto |
REFERENCE |
详细请参见表21。 |
短信认证配置 |
- |
|
weChatUrlAuthEnable |
boolean |
|
- |
微信链接认证 |
false |
weChatAuthEnable |
boolean |
|
- |
微信Portal一键认证 |
false |
|
|||||
twitterAuthEnable |
boolean |
|
- |
twitter认证 |
false |
sinaWeiboAuthEnable |
boolean |
|
- |
新浪微博认证 |
false |
qqAuthEnable |
boolean |
|
- |
QQ认证 |
false |
googleAuthEnable |
boolean |
|
- |
Google认证 |
false |
weComAuthEnable |
boolean |
|
- |
企业微信认证 |
false |
dingTalkEnable |
boolean |
|
- |
钉钉认证 |
false |
passcodeAuthEnable |
boolean |
|
- |
passcode认证 |
false |
oneKeyAuthEnable |
boolean |
|
- |
一键认证 |
false |
qrCodeAuthEnable |
boolean |
|
- |
公共二维码认证 |
false |
qrCodeRegisterEnable |
boolean |
|
false |
二维码审批认证 |
false |
emailAuthEnable |
boolean |
|
false |
邮箱认证 |
false |
masterPortalTemplateId |
string |
32~36个字符。 |
- |
主portal服务器模板标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
masterPortalTemplateName |
string |
1~32个字符。 |
- |
主portal服务器模板名称 |
"portal" |
slavePortalServerEnable |
boolean |
|
- |
portal备服务器开关 |
false |
slavePortalTemplateId |
string |
32~36个字符。 |
- |
备portal服务器模板标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
slavePortalTemplateName |
string |
1~32个字符。 |
- |
备portal服务器模板名称 |
"portal" |
|
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
registerEnable |
boolean |
|
- |
用户自注册开关 |
false |
userExpiredTime |
int32 |
[1-365] |
- |
用户有效期 |
10 |
userExpiredUnit |
string |
|
- |
用户有效期单位 分钟 小时 天 |
"day" |
passwdExpiredTime |
int32 |
[1-365] |
- |
密码有效期 |
10 |
passwdExpiredUnit |
string |
|
- |
密码有效期单位 分钟 小时 天 |
"minute" |
accessMaxNumber |
int32 |
[1-16] |
- |
最大接入终端数 |
5 |
userGroupId |
string |
32~36个字符。 |
- |
用户所属组标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
userGroupName |
string |
1~128个字符。 |
- |
用户所属组名称 |
"root" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
connectionMode |
int32 |
[0-1] |
- |
0 api 1 radius中继 |
0 |
pushProtocol |
int32 |
[0-1] |
- |
推送协议 0 https 1 http |
0 |
userNameKey |
string |
1~64个字符。 |
- |
用户名参数名称 |
"userName" |
passwordKey |
string |
1~64个字符。 |
- |
密码参数名称 |
"password" |
urlMatchMode |
int32 |
[0-1] |
- |
0 重定向url参数 1 重定向url地址 |
0 |
authSuccessUrlKey |
string |
0~256个字符。 |
- |
认证成功跳转URL参数名称 |
"authSuccessUrl" |
authFailUrlKey |
string |
0~256个字符。 |
- |
认证失败跳转URL参数名称 |
"authFailUrl" |
logoutSuccessUrlKey |
string |
0~256个字符。 |
- |
注销成功跳转URL参数名称 |
"logoutSuccessUrl" |
logoutFailUrlKey |
string |
0~256个字符。 |
- |
注销失败跳转URL |
"logoutFailUrl" |
logoutUrlKey |
string |
0~64个字符。 |
- |
注销页面URL参数名称 |
"logoutUrl" |
radiusRelayServerId |
string |
32~36个字符。 |
- |
RADIUS中继服务器标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
radiusRelayServerName |
string |
1~32个字符。 |
- |
RADIUS中继服务器名称 |
"radius" |
accountingEnable |
boolean |
|
- |
计费开关 |
false |
accountingPeriod |
int32 |
[5-65535] |
- |
费上报周期 单位分钟 |
10 |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
masterPortalTemplateId |
string |
32~36个字符。 |
- |
主portal服务器模板标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
masterPortalTemplateName |
string |
1~32个字符。 |
- |
主portal服务器模板名称 |
"portal" |
slavePortalServerEnable |
boolean |
|
- |
portal备服务器开关 |
false |
slavePortalTemplateId |
string |
32~36个字符。 |
- |
备portal服务器模板标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
slavePortalTemplateName |
string |
1~32个字符。 |
- |
备portal服务器模板名称 |
"portal" |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
radiusTemplateId |
string |
32~36个字符。 |
- |
radius服务器模板标识 |
"b90f8190-e12f-4323-95f3-4018309209c4" |
radiusTemplateName |
string |
1~32个字符。 |
- |
radius服务器模板名称 |
"portal" |
terminalAccessMode |
string |
|
multi-authen |
有线口终端接入模式(单终端接入:single-terminal,单普通终端通过语音终端接入:single-voice-with-data,多终端分别认证接入:multi-authen,仅第一个终端需要认证接入:multi-share;默认为:多终端分别认证接入)。有线认证生效。 |
"multi-authen" |
macBypassEnable |
boolean |
|
- |
mac旁路认证开关。有线认证生效。 |
false |
macWhitelistEnable |
boolean |
|
- |
mac白名单开关。无线认证生效。 |
false |
autoReAuthEnable |
boolean |
|
- |
自动重认证开关。无线认证生效。 |
false |
autoReAuthTime |
int32 |
[30-7200] |
- |
自动重认证时间,单位秒。无线认证生效。 |
30 |
coaAndDMForNATEnable |
boolean |
|
- |
支持NAT场景CoA/DM |
false |
protocolOfMacAuth |
string |
|
- |
认证协议。仅MAC认证场景使用此字段,MAC认证时如果不填,则默认为chap。 |
"chap" |
triggerPackets |
array<string> |
0-5 个列表项。每个列表项
|
- |
触发认证报文类型。有线认证生效。MAC认证和1x认证必填 |
["dhcp"] |
realTime |
REFERENCE |
详细请参见表25。 |
实时计费配置 |
- |
|
iconnectAccessEnable |
boolean |
|
false |
iConnect终端接入开关,默认值为false,仅支持云杉交换机。 |
- |
参数名称 |
类型 |
参数值域 |
默认值 |
参数说明 |
参数示例 |
---|---|---|---|---|---|
realTimeEnable |
boolean |
|
- |
实时计费 |
true |
realTimeInterval |
int32 |
[1-65535] |
- |
计费上报周期(分钟) |
15 |
返回状态码为400:校验异常。
详细信息请参见实际响应消息体。
返回状态码为500:内部错误。
详细信息请参见实际响应消息体。
响应示例
返回状态码为201:创建认证模板成功,响应体参考LswAuthConfigResponse。
HTTPS 201 OK Date: Thu,13 Sep 2022 10:00:00 GMT Server: example-server Content-Type: application/json { "errcode":"0", "errmsg":"", "data":[ { "id":"18e4c8f942254308ac4b9733297d4083", "name":null, "ssidName":null, "authMode":null, "escapeStrategy":null, "escapeStrategyId":null, "escapePolicyName":null, "apFreeAuthEnable":null, "forceDomainEnable": true, "preAuthPrivilege":null, "authFailPrivilege":null, "voiceDeviceNoAuth":null, "hasPermission":null, "portalConfigDto":null, "radiusConfigDto":null } ] }
返回状态码为400:校验异常。
HTTP/1.1 400 Bad Request Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive
返回状态码为500:内部错误。
HTTP/1.1 500 Internal Server Error Date: Sun,16 Feb 2025 10:00:00 GMT Server: example-server Content-Type: application/json;charset=UTF-8 Content-Length: 250 Connection: keep-alive