更新辅助认证策略配置 - UpdateAssistAuthMethodConfig

功能介绍

更新辅助认证策略配置。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

workspace:assistAuthConfigs:update

Write

-

-

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:assistAuthConfigs:update	Write	-	-	-	-

URI

PUT /v2/{project_id}/assist-auth-config/method-config

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
auth_type	否	String	认证类型。 OTP：OTP辅助认证 RADIUS: RADIUS认证
otp_config_info	否	OtpConfigInfo object	OTP辅助认证方式配置。

表3 OtpConfigInfo
参数	是否必选	参数类型	描述
id	否	String	认证id。
enable	否	Boolean	是否启用。
receive_mode	否	String	验证码接收模式 VMFA：虚拟MFA设备 HMFA：硬件MFA设备
auth_url	否	String	辅助认证服务器地址。
app_id	否	String	认证服务接入账号。
app_secret	否	String	认证服务接入密码。
auth_server_access_mode	否	String	辅助认证服务接入模式 INTERNET：互联网接入 DEDICATED：专线接入 SYSTEM_DEFAULT：系统默认
cert_content	否	String	pem格式证书内容。
apply_rule	否	ApplyRuleInfo object	认证应用对象信息，为null时代表对所有应用对象生效。
apply_objects	否	Array of ApplyObjects objects	要应用的用户/用户组列表。

表4 ApplyRuleInfo
参数	是否必选	参数类型	描述
rule_type	否	String	认证应用对象类型。 ACCESS_MODE：接入类型
rule	否	String	认证应用对象。 INTERNET：互联网接入，rule_type为ACCESS_MODE时可选该值 PRIVATE：专线接入，rule_type为ACCESS_MODE时可选该值

表5 ApplyObjects
参数	是否必选	参数类型	描述
object_type	是	String	绑定对象类型枚举。 USER：用户 USER_GROUP：用户组 ALL: 全部用户
object_id	是	String	用户/用户组id。
object_name	是	String	用户/用户组名称。

响应参数

状态码：204

正常。

状态码：400

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

PUT /v2/fb2e5ec048384c8f9469d22db0037908/assist-auth-config/method-config

{
  "auth_type" : "OTP",
  "otp_config_info" : {
    "enable" : true,
    "receive_mode" : "VMFA",
    "apply_rule" : {
      "rule_type" : "ACCESS_MODE",
      "rule" : "INTERNET"
    }
  }
}

PUT /v2/fb2e5ec048384c8f9469d22db0037908/assist-auth-config/method-config

{
  "auth_type" : "OTP",
  "otp_config_info" : {
    "enable" : true,
    "receive_mode" : "HMFA",
    "auth_url" : "https://10.0.0.128:8443/api/um/login",
    "app_id" : 123,
    "app_secret" : 123,
    "auth_server_access_mode" : "DEDICATED",
    "cert_content" : "cert_content",
    "apply_rule" : {
      "rule_type" : "ACCESS_MODE",
      "rule" : "INTERNET"
    },
    "apply_objects" : [ {
      "object_type" : "USER",
      "object_id" : "xxxxxxx",
      "object_name" : "xxxxx"
    }, {
      "object_type" : "USER_GROUP",
      "object_id" : "xxxxxxx",
      "object_name" : "xxxxx"
    }, {
      "object_type" : "ALL",
      "object_id" : "default-apply-all-users",
      "object_name" : "All-Users"
    } ]
  }
}

响应示例

无

状态码

状态码	描述
204	正常。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
500	服务内部错误，具体返回错误码请参见错误码说明。