Updates the auxiliary authentication policy configuration.

Function

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API that is used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Content-Type	Yes	String	MIME type of the request body.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
auth_type	No	String	Authentication type. OTP: OTP-assisted authentication
otp_config_info	No	OtpConfigInfo object	Configures OTP-assisted authentication.

**Table 4** OtpConfigInfo
Parameter	Mandatory	Type	Description
enable	No	Boolean	Whether to enable.
receive_mode	No	String	Verification code receiving mode. VMFA: virtual MFA device HMFA: hardware MFA device
auth_url	No	String	Auxiliary authentication server address.
app_id	No	String	Account for accessing the authentication service.
app_secret	No	String	Password for accessing the authentication service.
auth_server_access_mode	No	String	Access mode of the auxiliary authentication service. INTERNET: access through Internet DEDICATED: access through Direct Connect SYSTEM_DEFAULT: default access mode
cert_content	No	String	Certificate in PEM format.
apply_rule	No	ApplyRuleInfo object	Information about the object to which authentication applies. If the value is null, authentication applies to all objects.

**Table 5** ApplyRuleInfo
Parameter	Mandatory	Type	Description
rule_type	No	String	Type of the object to which authentication applies. ACCESS_MODE: access type
rule	No	String	Object to which authentication applies. INTERNET: Internet access. This value can be selected when rule_type is set to ACCESS_MODE. PRIVATE: private line access. This value can be selected when rule_type is set to ACCESS_MODE.

Response Parameters

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

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

Example Responses

None

Status Codes

Status Code	Description
204	Normal.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	You do not have required permissions.
404	No resource found.
500	An internal service error occurred. For details about the error code, see the error code description.