安全认证管理
1.修改认证
接口功能介绍
无
接口约束
无
URI
POST /cgw/v1/security/auth/update
Content-Type: application/json
路径参数
Query参数
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionId | 是 | String | 资源池编码 | 7a2828074ef6e32e041a2ef124b19e63 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
enable | 是 | Boolean | 是否启用 | false | |
instId | 是 | String | 实例 Id | 7a2828074ef6e32e041a2ef124b19e63 | |
jwtAuthDTO | 否 | Object | JWT 类型请求参数 | JwtAuthDTO | |
name | 是 | String | 标识名称 | test-jwt | |
oidcAuthDTO | 否 | Object | OIDC 类型请求参数 | OidcAuthDTO | |
type | 是 | String | 鉴权类型,如JWT | JWT |
表 JwtAuthDTO
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
algorithm | 否 | String | 加密算法。可选值:["HS256", "HS512", "RS256"],默认值为"HS256"。JWT 类型请求参数 | HS256 | |
base64Secret | 否 | Boolean | 当设置为 true 时,密钥为 base64 编码, 默认值 false | false | |
cookie | 否 | String | 从 cookie 的位置校验 token 参数,默认值为 jwt。JWT 类型请求参数 | jwt | |
exp | 否 | Integer | token 的超时时间,单位秒,默认值 86400 | 86400 | |
header | 否 | String | 从 header 的位置校验 token 参数,默认值为 authorization,header 优先级高于query、cookie,JWT 类型请求参数 | authorization | |
privateKey | 否 | String | RSA 私钥, algorithm 属性选择 RS256 算法时必填。JWT 类型请求参数 | String | |
publicKey | 否 | String | RSA 公钥,algorithm 属性选择 RS256 算法时必填。JWT 类型请求参数 | String | |
query | 否 | String | 从 query 的位置校验 token 参数,默认值为 jwt,query 优先级高于 cookie。JWT 类型请求参数 | jwt | |
secret | 否 | String | secret, 加密秘钥。HS算法时,必填 | key |
表 OidcAuthDTO
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
accessTokenInAuthorizationHeader | 否 | Boolean | 当值为 true 时,将访问令牌设置在请求头参数 Authorization,否则将使用请求头参数 X-Access-Token,默认值 false, 可选项 | false | |
bearerOnly | 否 | Boolean | 设置为 true 将检查请求中带有承载令牌的授权标头,默认值 false, 可选项 | false | |
clientId | 否 | String | OAuth 客户端 ID,是否必填项 | 1 | |
clientSecret | 否 | String | OAuth 客户端 secret,是否必填项 | key | |
discovery | 否 | String | 身份认证服务暴露的服务发现端点,是否必填项 | ||
introspectionEndpoint | 否 | String | 身份服务器的令牌验证端点的 URL, 可选项 | ||
introspectionEndpointAuthMethod | 否 | String | 令牌自省的认证方法名称, 默认值 client_secret_basic, 可选项 | ||
logoutPath | 否 | String | 默认值 /logout, 可选项 | /logout | |
publicKey | 否 | String | 验证令牌的公钥, 可选项 | ||
realm | 否 | String | 用于认证,默认值 apisix, 可选项 | apisix | |
redirectUrl | 否 | String | 身份提供者重定向返回的 URI,默认值 ngx.var.request_uri, 可选项 | ngx.var.request_uri | |
scope | 否 | String | 用于认证的范围,默认值 openid, 可选项 | openid | |
setAccessTokenHeader | 否 | Boolean | 在请求头设置访问令牌,默认值 true, 可选项 | true | |
setIdTokenHeader | 否 | Boolean | 是否将 ID 令牌设置到请求头参数 X-ID-Token,默认值 true, 可选项 | true | |
setUserinfoHeader | 否 | Boolean | 是否将用户信息对象设置到请求头参数 X-Userinfo,默认值 true, 可选项 | true | |
sslVerify | 否 | Boolean | 默认值 false, 可选项 | false | |
timeout | 否 | Integer | 超时时间,单位为秒, 大于1,默认值 3, 可选项 | 3 | |
tokenSigningAlgValuesExpected | 否 | String | 用于对令牌进行签名的算法, 可选项 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | Integer | 接口状态码 | 2000 | |
code | String | 错误码,异常时非空 | CGW_1001 | |
returnObj | Object | 返回数据 | {} | |
message | String | 异常描述 | success |
请求示例
请求url
https://127.0.0.1:8080/cgw/v1/security/auth/update
请求头header
{
"regionId": "1234567890"
}
请求体body
{
"name": "hs-test",
"enable": false,
"type": "JWT",
"jwtAuthDTO": {
"algorithm": "HS256",
"base64Secret": false,
"cookie": "jwt",
"secret": "key",
"publicKey": "",
"privateKey": "",
"query": "jwt",
"header": "authorization",
"exp": 86400
},
"instId": "878da73f7dba36ff0ae80e004a4f28f9"
}
响应示例
{
"statusCode": 2000,
"message": "success",
"returnObj": {}
}
状态码
请参考 状态码说明。
错误码
请参考 错误码说明。