Help Center/ Workspace/ API Reference/ Workspace APIs/ Tenant Configuration/ Queries the configuration of auxiliary authentication

Updated on 2025-07-14 GMT+08:00

View PDF

Queries the configuration of auxiliary authentication

Queries auxiliary authentication configurations.

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

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

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

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	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.

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
otp_config_info	OtpConfigInfo object	OTP-assisted authentication configuration.

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

**Table 5** ApplyRuleInfo
Parameter	Type	Description
rule_type	String	Type of the object to which authentication applies. ACCESS_MODE: access type
rule	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.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
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 description.
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 description.
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 description.
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 description.
encoded_authorization_message	String	Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

GET /v2/29dfe82ada564ac2b927e1ff036d9a9b/assist-auth-config/method-config

Status code: 200

Response to the request for querying auxiliary authentication-based login modes.

{
  "otp_config_info" : {
    "enable" : true,
    "receive_mode" : "VMFA"
  }
}

Status Code	Description
200	Response to the request for querying auxiliary authentication-based login modes.
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.