Wei, Hongmin 80f18fd272 IAM API 2.6 Version

Reviewed-by: Kabai, Zoltán Gábor <zoltan-gabor.kabai@t-systems.com>
Co-authored-by: Wei, Hongmin <weihongmin1@huawei.com>
Co-committed-by: Wei, Hongmin <weihongmin1@huawei.com>

2023-08-03 03:34:59 +00:00

14 KiB

Raw Blame History

Modifying the Operation Protection Policy

Function

This API is provided for the administrator to modify the operation protection policy.

URI

PUT /v3.0/OS-SECURITYPOLICY/domains/{domain_id}/protect-policy

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Domain ID.

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Token with Security Administrator permissions.

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
protect_policy	Yes	object	Operation protection policy.

**Table 4** protect_policy
Parameter	Mandatory	Type	Description
operation_protection	Yes	Boolean	Indicates whether operation protection has been enabled. The value can be true or false.

Response Parameters

**Table 5** Parameters in the response body
Parameter	Type	Description
protect_policy	object	Operation protection policy.

**Table 6** protect_policy
Parameter	Type	Description
operation_protection	Boolean	Indicates whether operation protection has been enabled. The value can be true or false.

Example Request

PUT https://sample.domain.com/v3.0/OS-SECURITYPOLICY/domains/{domain_id}/protect-policy 
 
{ 
  "protect_policy" : { 
    "operation_protection" : true 
  } 
}

Example Response

Status code: 200

The request is successful.

{ 
  "protect_policy" : { 
    "operation_protection" : false 
  } 
}

Status code: 400

The request body is abnormal.

Example 1

{ 
   "error_msg" : "'%(key)s' is a required property.", 
   "error_code" : "IAM.0072" 
 }

Example 2

{ 
   "error_msg" : "Invalid input for field '%(key)s'. The value is '%(value)s'.", 
   "error_code" : "IAM.0073" 
 }

Status code: 403

Access denied.

Example 1

{ 
   "error_msg" : "Policy doesn't allow %(actions)s to be performed.", 
   "error_code" : "IAM.0003" 
 }

Example 2

{ 
   "error_msg" : "You are not authorized to perform the requested action.", 
   "error_code" : "IAM.0002" 
 }

Status code: 500

The system is abnormal.

{ 
  "error_msg" : "An unexpected error prevented the server from fulfilling your request.", 
  "error_code" : "IAM.0006" 
}

Status Codes

Status Code	Description
200	The request is successful.
400	The request body is abnormal.
401	Authentication failed.
403	Access denied.
500	The system is abnormal.

Parent topic: Security Settings

14 KiB Raw Blame History