Help Center/ Workspace/ API Reference/ Workspace APIs/ Tenant Configuration/ Updates the auxiliary authentication policy configuration

Updated on 2026-02-10 GMT+08:00

View PDF

Updates the auxiliary authentication policy configuration

Function

Updates the auxiliary authentication policy configuration.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:assistAuthConfigs:update	Write	-	-	-	-

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 body parameters
Parameter	Mandatory	Type	Description
auth_type	No	String	Authentication type. OTP: OTP-assisted authentication
otp_config_info	No	OtpConfigInfo object	OTP-assisted authentication configuration.

**Table 3** OtpConfigInfo
Parameter	Mandatory	Type	Description
id	No	String	Authentication ID.
enable	No	Boolean	Enabled or not.
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.
apply_objects	No	Array of ApplyObjects objects	Users or user groups to be applied.

**Table 4** 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.

**Table 5** ApplyObjects
Parameter	Mandatory	Type	Description
object_type	Yes	String	Type of bound objects. USER: user USER_GROUP: user group ALL: all users
object_id	Yes	String	User ID or user group ID.
object_name	Yes	String	Username or user group name.

Response Parameters

Status code: 204

Normal.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 401

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 403

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
error_detail	String	Error details.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

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

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	No operation permissions.
404	No resources found.
500	An internal service error occurred. For details about the error code, see the error code description.