Incrementally Updating an Authentication Configuration
Function
Incrementally update a specified authentication 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, no identity policy-based permission required for calling this API.
URI
PUT /v2/{project_id}/auth-configs/{auth_config_id}
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Project ID. |
| auth_config_id | Yes | String | Authentication configuration ID. |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| sms_login_enabled | No | Boolean | Whether to enable SMS login. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| auth_config_id | String | Authentication configuration ID. |
| sms_login_enabled | Boolean | Whether to enable SMS login. |
Status code: 400
| 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
| 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
| 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
| 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
| 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/auth-configs/1234567890
{
"sms_login_enabled" : true
} Example Responses
Status code: 200
Successful response to the request for incrementally updating an authentication configuration.
{
"auth_config_id" : 1234567890,
"sms_login_enabled" : true
} Status Codes
| 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. |
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