Queries the configuration of auxiliary authentication.
Function
Queries the configuration of auxiliary authentication.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v2/{project_id}/assist-auth-config/method-config
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request 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. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
otp_config_info |
OtpConfigInfo object |
Configures OTP-assisted authentication. |
Parameter |
Type |
Description |
---|---|---|
enable |
Boolean |
Whether to enable. |
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. |
Parameter |
Type |
Description |
---|---|---|
rule_type |
String |
Type of the object to which authentication applies.
|
rule |
String |
Object to which authentication applies.
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
GET /v2/29dfe82ada564ac2b927e1ff036d9a9b/assist-auth-config/method-config
Example Responses
Status code: 200
Response to the request for querying the login with auxiliary authentication.
{ "otp_config_info" : { "enable" : true, "receive_mode" : "VMFA" } }
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the request for querying the login with auxiliary authentication. |
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. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot