更新时间:2024-01-11 GMT+08:00

更新辅助认证策略配置

功能介绍

更新辅助认证策略配置

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Content-Type

String

发送的实体的MIME类型

表3 请求Body参数

参数

是否必选

参数类型

描述

auth_type

String

认证类型。 OTP:OTP辅助认证

otp_config_info

OtpConfigInfo object

OTP辅助认证方式配置

表4 OtpConfigInfo

参数

是否必选

参数类型

描述

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时代表对所有应用对象生效。

表5 ApplyRuleInfo

参数

是否必选

参数类型

描述

rule_type

String

认证应用对象类型。

  • ACCESS_MODE:接入类型

rule

String

认证应用对象。

  • INTERNET:互联网接入,rule_type为ACCESS_MODE时可选该值

  • PRIVATE:专线接入,rule_type为ACCESS_MODE时可选该值

响应参数

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

状态码: 500

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

  • 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"
        }
      }
    }

响应示例

状态码

状态码

描述

204

正常

400

由于包含语法错误,当前请求无法被服务器理解。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误,具体返回错误码请参见错误码说明。

错误码

请参见错误码