网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts 盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

创建站点下交换机有线认证模板配置

更新时间:2025-02-17 GMT+08:00
分享

典型场景

创建站点下交换机有线认证模板配置。

接口功能

页面功能:部署/设备部署/站点配置/站点配置/交换机/认证/有线认证/创建操作

创建站点下交换机有线认证模板配置。

接口约束

该接口支持租户下北向管理员(用户角色为“Open Api Operator”)访问,必须在用户会话建立后使用。

调用方法

POST

URI

/controller/campus/api/v1/lswauth/wired/{siteId}

表1 path参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

siteId

string

36个字符。

-

站点标识,UUID格式。

"fbde1c5d-5b94-49e3-a912-48641015e45c"

请求参数

表2 body参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

lswAuthConfigDto

REFERENCE

详细请参见表3

交换机认证模板配置信息。

-

表3 LswAuthConfigDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

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

  • true

  • false

-

使能端口下AP免认证

false

forceDomainEnable

boolean

  • true

  • false

true

强制域使能

true

preAuthPrivilege

REFERENCE

详细请参见表4

语音终端免认证,仅交换机有线认证支持

-

authFailPrivilege

REFERENCE

详细请参见表5

终端认证失败网络访问权限

-

voiceDeviceNoAuth

REFERENCE

详细请参见表6

终端预连接网络访问权限

-

hasPermission

boolean

  • true

  • false

-

是否有操作权限

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"

表4 preAuthPrivilegeDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

preAuthPrivilegeEnable

boolean

  • true

  • false

-

开启终端预连接网络访问权限

false

vlan

int32

[1-4094]

-

vlan编号

1

表5 authFailPrivilegeDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

authFailPrivilegeEnable

boolean

  • true

  • false

-

开启终端认证失败网络访问权限

false

vlan

int32

[1-4094]

-

vlan编号

1

表6 voiceDeviceNoAuthDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

voiceDeviceNoAuthEnable

boolean

  • true

  • false

-

使能语音终端免认证

false

vlan

int32

[1-4094]

-

vlan编号

1

表7 PortalConfigDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

pagePushMode

int32

[0-2]

-

0 云平台内置 1 云平台中继 2 第三方

0

freeAuthEnable

boolean

  • true

  • false

-

免认证开关

false

freeAuthExpired

int32

[1-365]

-

免认证有效期

10

freeAuthExpiredUnit

string

  • minute

  • hour

  • day

-

免认证有效期单位 分钟 小时 天

"minute"

internalPortalConfigDto

REFERENCE

详细请参见表8

云平台内置认证配置,pagePushMode为0时必填

-

relayPortalConfigDto

REFERENCE

详细请参见表10

云平台中继认证配置,pagePushMode为1时必填

-

thirdPortalConfigDto

REFERENCE

详细请参见表11

第三方认证配置,pagePushMode为2时必填

-

表8 InternalPortalConfigDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

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

  • true

  • false

-

IPv6终端认证 开关

false

accountingEnable

boolean

  • true

  • false

-

计费开关

false

accountingPeriod

int32

[5-65535]

-

费上报周期 单位分钟

10

anonymousAuthEnable

boolean

  • true

  • false

-

匿名认证

false

normalAuthEnable

boolean

  • true

  • false

-

普通用户名密码认证

false

normalAccessConfigDto

REFERENCE

详细请参见表9

普通用户名密码认证配置

-

smsAuthEnable

boolean

  • true

  • false

-

短信认证

false

smsAccessConfigDto

REFERENCE

详细请参见表9

短信认证配置

-

weChatUrlAuthEnable

boolean

  • true

  • false

-

微信链接认证

false

weChatAuthEnable

boolean

  • true

  • false

-

微信Portal一键认证

false

socialMediaAuthEnable

boolean

  • true

  • false

-

社交媒体认证

false

twitterAuthEnable

boolean

  • true

  • false

-

twitter认证

false

sinaWeiboAuthEnable

boolean

  • true

  • false

-

新浪微博认证

false

qqAuthEnable

boolean

  • true

  • false

-

QQ认证

false

googleAuthEnable

boolean

  • true

  • false

-

Google认证

false

weComAuthEnable

boolean

  • true

  • false

-

企业微信认证

false

dingTalkEnable

boolean

  • true

  • false

-

钉钉认证

false

passcodeAuthEnable

boolean

  • true

  • false

-

passcode认证

false

oneKeyAuthEnable

boolean

  • true

  • false

-

一键认证

false

qrCodeAuthEnable

boolean

  • true

  • false

-

公共二维码认证

false

qrCodeRegisterEnable

boolean

  • true

  • false

false

二维码审批认证

false

emailAuthEnable

boolean

  • true

  • false

false

邮箱认证

false

masterPortalTemplateId

string

32~36个字符。

-

主portal服务器模板标识

"b90f8190-e12f-4323-95f3-4018309209c4"

masterPortalTemplateName

string

1~32个字符。

-

主portal服务器模板名称

"portal"

slavePortalServerEnable

boolean

  • true

  • false

-

portal备服务器开关

false

slavePortalTemplateId

string

32~36个字符。

-

备portal服务器模板标识

"b90f8190-e12f-4323-95f3-4018309209c4"

slavePortalTemplateName

string

1~32个字符。

-

备portal服务器模板名称

"portal"

authorRedirectUrlParamEnable

boolean

  • true

  • false

-

授权重定向场景携带URL参数

false

表9 AccessConfigDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

registerEnable

boolean

  • true

  • false

-

用户自注册开关

false

userExpiredTime

int32

[1-365]

-

用户有效期

10

userExpiredUnit

string

  • minute

  • hour

  • day

-

用户有效期单位 分钟 小时 天

"day"

passwdExpiredTime

int32

[1-365]

-

密码有效期

10

passwdExpiredUnit

string

  • minute

  • hour

  • day

-

密码有效期单位 分钟 小时 天

"minute"

accessMaxNumber

int32

[1-16]

-

最大接入终端数

5

userGroupId

string

32~36个字符。

-

用户所属组标识

"b90f8190-e12f-4323-95f3-4018309209c4"

userGroupName

string

1~128个字符。

-

用户所属组名称

"root"

表10 RelayPortalConfigDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

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

  • true

  • false

-

计费开关

false

accountingPeriod

int32

[5-65535]

-

费上报周期 单位分钟

10

表11 ThirdPortalConfigDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

masterPortalTemplateId

string

32~36个字符。

-

主portal服务器模板标识

"b90f8190-e12f-4323-95f3-4018309209c4"

masterPortalTemplateName

string

1~32个字符。

-

主portal服务器模板名称

"portal"

slavePortalServerEnable

boolean

  • true

  • false

-

portal备服务器开关

false

slavePortalTemplateId

string

32~36个字符。

-

备portal服务器模板标识

"b90f8190-e12f-4323-95f3-4018309209c4"

slavePortalTemplateName

string

1~32个字符。

-

备portal服务器模板名称

"portal"

表12 RadiusConfigDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

radiusTemplateId

string

32~36个字符。

-

radius服务器模板标识

"b90f8190-e12f-4323-95f3-4018309209c4"

radiusTemplateName

string

1~32个字符。

-

radius服务器模板名称

"portal"

terminalAccessMode

string

  • single-terminal

  • single-voice-with-data

  • multi-authen

  • multi-share

multi-authen

有线口终端接入模式(单终端接入:single-terminal,单普通终端通过语音终端接入:single-voice-with-data,多终端分别认证接入:multi-authen,仅第一个终端需要认证接入:multi-share;默认为:多终端分别认证接入)。有线认证生效。

"multi-authen"

macBypassEnable

boolean

  • true

  • false

-

mac旁路认证开关。有线认证生效。

false

macWhitelistEnable

boolean

  • true

  • false

-

mac白名单开关。无线认证生效。

false

autoReAuthEnable

boolean

  • true

  • false

-

自动重认证开关。无线认证生效。

false

autoReAuthTime

int32

[30-7200]

-

自动重认证时间,单位秒。无线认证生效。

30

coaAndDMForNATEnable

boolean

  • true

  • false

-

支持NAT场景CoA/DM

false

protocolOfMacAuth

string

  • chap

  • pap

-

认证协议。仅MAC认证场景使用此字段,MAC认证时如果不填,则默认为chap。

"chap"

triggerPackets

array<string>

0-5 个列表项。每个列表项

  • dhcp

  • arp

  • dhcpv6

  • nd

  • any-l2-packet

-

触发认证报文类型。有线认证生效。MAC认证和1x认证必填

["dhcp"]

realTime

REFERENCE

详细请参见表13

实时计费配置

-

iconnectAccessEnable

boolean

  • true

  • false

false

iConnect终端接入开关,默认值为false,仅支持云杉交换机。

-

表13 RealTimeDto对象的参数列表

参数名称

必选

类型

参数值域

默认值

参数说明

参数示例

realTimeEnable

boolean

  • true

  • false

-

实时计费

true

realTimeInterval

int32

[1-65535]

-

计费上报周期(分钟)

15

请求示例

HTTP的示例
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。

表14 LswAuthConfigResponse对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

errcode

string

0~64个字符。

-

错误码。

"0"

errmsg

string

0~256个字符。

-

错误信息。

""

data

ARRAY_REFERENCE

0-64个列表项,详细请参见表15

返回消息体的具体信息

-

表15 LswAuthConfigDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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

  • true

  • false

-

使能端口下AP免认证

false

forceDomainEnable

boolean

  • true

  • false

true

强制域使能

true

preAuthPrivilege

REFERENCE

详细请参见表16

语音终端免认证,仅交换机有线认证支持

-

authFailPrivilege

REFERENCE

详细请参见表17

终端认证失败网络访问权限

-

voiceDeviceNoAuth

REFERENCE

详细请参见表18

终端预连接网络访问权限

-

hasPermission

boolean

  • true

  • false

-

是否有操作权限

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"

表16 preAuthPrivilegeDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

preAuthPrivilegeEnable

boolean

  • true

  • false

-

开启终端预连接网络访问权限

false

vlan

int32

[1-4094]

-

vlan编号

1

表17 authFailPrivilegeDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

authFailPrivilegeEnable

boolean

  • true

  • false

-

开启终端认证失败网络访问权限

false

vlan

int32

[1-4094]

-

vlan编号

1

表18 voiceDeviceNoAuthDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

voiceDeviceNoAuthEnable

boolean

  • true

  • false

-

使能语音终端免认证

false

vlan

int32

[1-4094]

-

vlan编号

1

表19 PortalConfigDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

pagePushMode

int32

[0-2]

-

0 云平台内置 1 云平台中继 2 第三方

0

freeAuthEnable

boolean

  • true

  • false

-

免认证开关

false

freeAuthExpired

int32

[1-365]

-

免认证有效期

10

freeAuthExpiredUnit

string

  • minute

  • hour

  • day

-

免认证有效期单位 分钟 小时 天

"minute"

internalPortalConfigDto

REFERENCE

详细请参见表20

云平台内置认证配置,pagePushMode为0时必填

-

relayPortalConfigDto

REFERENCE

详细请参见表22

云平台中继认证配置,pagePushMode为1时必填

-

thirdPortalConfigDto

REFERENCE

详细请参见表23

第三方认证配置,pagePushMode为2时必填

-

表20 InternalPortalConfigDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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

  • true

  • false

-

IPv6终端认证 开关

false

accountingEnable

boolean

  • true

  • false

-

计费开关

false

accountingPeriod

int32

[5-65535]

-

费上报周期 单位分钟

10

anonymousAuthEnable

boolean

  • true

  • false

-

匿名认证

false

normalAuthEnable

boolean

  • true

  • false

-

普通用户名密码认证

false

normalAccessConfigDto

REFERENCE

详细请参见表21

普通用户名密码认证配置

-

smsAuthEnable

boolean

  • true

  • false

-

短信认证

false

smsAccessConfigDto

REFERENCE

详细请参见表21

短信认证配置

-

weChatUrlAuthEnable

boolean

  • true

  • false

-

微信链接认证

false

weChatAuthEnable

boolean

  • true

  • false

-

微信Portal一键认证

false

socialMediaAuthEnable

boolean

  • true

  • false

-

社交媒体认证

false

twitterAuthEnable

boolean

  • true

  • false

-

twitter认证

false

sinaWeiboAuthEnable

boolean

  • true

  • false

-

新浪微博认证

false

qqAuthEnable

boolean

  • true

  • false

-

QQ认证

false

googleAuthEnable

boolean

  • true

  • false

-

Google认证

false

weComAuthEnable

boolean

  • true

  • false

-

企业微信认证

false

dingTalkEnable

boolean

  • true

  • false

-

钉钉认证

false

passcodeAuthEnable

boolean

  • true

  • false

-

passcode认证

false

oneKeyAuthEnable

boolean

  • true

  • false

-

一键认证

false

qrCodeAuthEnable

boolean

  • true

  • false

-

公共二维码认证

false

qrCodeRegisterEnable

boolean

  • true

  • false

false

二维码审批认证

false

emailAuthEnable

boolean

  • true

  • false

false

邮箱认证

false

masterPortalTemplateId

string

32~36个字符。

-

主portal服务器模板标识

"b90f8190-e12f-4323-95f3-4018309209c4"

masterPortalTemplateName

string

1~32个字符。

-

主portal服务器模板名称

"portal"

slavePortalServerEnable

boolean

  • true

  • false

-

portal备服务器开关

false

slavePortalTemplateId

string

32~36个字符。

-

备portal服务器模板标识

"b90f8190-e12f-4323-95f3-4018309209c4"

slavePortalTemplateName

string

1~32个字符。

-

备portal服务器模板名称

"portal"

authorRedirectUrlParamEnable

boolean

  • true

  • false

-

授权重定向场景携带URL参数

false

表21 AccessConfigDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

registerEnable

boolean

  • true

  • false

-

用户自注册开关

false

userExpiredTime

int32

[1-365]

-

用户有效期

10

userExpiredUnit

string

  • minute

  • hour

  • day

-

用户有效期单位 分钟 小时 天

"day"

passwdExpiredTime

int32

[1-365]

-

密码有效期

10

passwdExpiredUnit

string

  • minute

  • hour

  • day

-

密码有效期单位 分钟 小时 天

"minute"

accessMaxNumber

int32

[1-16]

-

最大接入终端数

5

userGroupId

string

32~36个字符。

-

用户所属组标识

"b90f8190-e12f-4323-95f3-4018309209c4"

userGroupName

string

1~128个字符。

-

用户所属组名称

"root"

表22 RelayPortalConfigDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

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

  • true

  • false

-

计费开关

false

accountingPeriod

int32

[5-65535]

-

费上报周期 单位分钟

10

表23 ThirdPortalConfigDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

masterPortalTemplateId

string

32~36个字符。

-

主portal服务器模板标识

"b90f8190-e12f-4323-95f3-4018309209c4"

masterPortalTemplateName

string

1~32个字符。

-

主portal服务器模板名称

"portal"

slavePortalServerEnable

boolean

  • true

  • false

-

portal备服务器开关

false

slavePortalTemplateId

string

32~36个字符。

-

备portal服务器模板标识

"b90f8190-e12f-4323-95f3-4018309209c4"

slavePortalTemplateName

string

1~32个字符。

-

备portal服务器模板名称

"portal"

表24 RadiusConfigDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

radiusTemplateId

string

32~36个字符。

-

radius服务器模板标识

"b90f8190-e12f-4323-95f3-4018309209c4"

radiusTemplateName

string

1~32个字符。

-

radius服务器模板名称

"portal"

terminalAccessMode

string

  • single-terminal

  • single-voice-with-data

  • multi-authen

  • multi-share

multi-authen

有线口终端接入模式(单终端接入:single-terminal,单普通终端通过语音终端接入:single-voice-with-data,多终端分别认证接入:multi-authen,仅第一个终端需要认证接入:multi-share;默认为:多终端分别认证接入)。有线认证生效。

"multi-authen"

macBypassEnable

boolean

  • true

  • false

-

mac旁路认证开关。有线认证生效。

false

macWhitelistEnable

boolean

  • true

  • false

-

mac白名单开关。无线认证生效。

false

autoReAuthEnable

boolean

  • true

  • false

-

自动重认证开关。无线认证生效。

false

autoReAuthTime

int32

[30-7200]

-

自动重认证时间,单位秒。无线认证生效。

30

coaAndDMForNATEnable

boolean

  • true

  • false

-

支持NAT场景CoA/DM

false

protocolOfMacAuth

string

  • chap

  • pap

-

认证协议。仅MAC认证场景使用此字段,MAC认证时如果不填,则默认为chap。

"chap"

triggerPackets

array<string>

0-5 个列表项。每个列表项

  • dhcp

  • arp

  • dhcpv6

  • nd

  • any-l2-packet

-

触发认证报文类型。有线认证生效。MAC认证和1x认证必填

["dhcp"]

realTime

REFERENCE

详细请参见表25

实时计费配置

-

iconnectAccessEnable

boolean

  • true

  • false

false

iConnect终端接入开关,默认值为false,仅支持云杉交换机。

-

表25 RealTimeDto对象的参数列表

参数名称

类型

参数值域

默认值

参数说明

参数示例

realTimeEnable

boolean

  • true

  • false

-

实时计费

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
提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容