Incrementally Updating an Authentication Configuration

Incrementally update a specified authentication configuration.

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

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, no identity policy-based permission required for calling this API.

PUT /v2/{project_id}/auth-configs/{auth_config_id}

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

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
sms_login_enabled	No	Boolean	Whether to enable SMS login.
login_captcha	No	LoginCaptchaConfig object	Configuration related to the slider CAPTCHA.

**Table 3** LoginCaptchaConfig
Parameter	Mandatory	Type	Description
enabled	No	Boolean	Whether to enable the slider CAPTCHA.
trigger_threshold	No	Integer	When the number of failed login attempts reaches the value of trigger_threshold, verification code authentication is required. This parameter is meaningless when the verification code authentication is not enabled. If it is enabled and this parameter is not specified, the default value 3 is used.

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
auth_config_id	String	Authentication configuration ID.
sms_login_enabled	Boolean	Whether to enable SMS login.
login_captcha	LoginCaptchaConfig object	Configuration related to the slider CAPTCHA.

**Table 5** LoginCaptchaConfig
Parameter	Type	Description
enabled	Boolean	Whether to enable the slider CAPTCHA.
trigger_threshold	Integer	When the number of failed login attempts reaches the value of trigger_threshold, verification code authentication is required. This parameter is meaningless when the verification code authentication is not enabled. If it is enabled and this parameter is not specified, the default value 3 is used.

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.

PUT /v2/fb2e5ec048384c8f9469d22db0037908/auth-configs/1234567890

{
  "sms_login_enabled" : true
}

Status code: 200

Successful response to the request for incrementally updating an authentication configuration.

{
  "auth_config_id" : 1234567890,
  "sms_login_enabled" : true
}

Status Code	Description
200	Successful response to the request for incrementally updating an authentication configuration.
400	The request cannot be understood by the server due to malformed syntax.
401	Authorization failed.
403	No permissions.
404	Resources not found.
500	An internal service error occurred. For details, see the error code description.

Parent topic: Tenant Configuration

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.