Help Center/ Workspace/ API Reference/ Workspace APIs/ Access policy/ Updates the object to which a specified access policy is applied.

Updated on 2024-01-10 GMT+08:00

View PDF

Updates the object to which a specified access policy is applied.

Function

Debugging

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

URI

PUT /v2/{project_id}/access-policy/{access_policy_id}/objects

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

Request Parameters

**Table 2** Request header 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, for example, application/json.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
policy_objects_list	No	Array of AccessPolicyObjectInfo objects	Request for updating the list of objects to which a policy is applied.

**Table 4** AccessPolicyObjectInfo
Parameter	Mandatory	Type	Description
object_id	Yes	String	ID of an object in the blacklist. The object can only be a user object.
object_type	Yes	String	Object type. USER: user USERGROUP: user group
object_name	No	String	Object name. This parameter will not be verified later.

Response Parameters

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 404

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 405

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 503

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

put /v2/0e973a948e8091232f25c00673f168b7/access-policy/20b726affecc4411bcdc49a66e3e8f63/objects

{
  "policy_objects_list" : [ {
    "object_id" : "8ac225c2781edb0d01781edde3f4xxxx",
    "object_type" : "USER"
  }, {
    "object_id" : "8ac225c2781edb0d01781edde3f4xxxx",
    "object_type" : "USER"
  } ]
}

Example Responses

None

Status Codes

Status Code	Description
200	Normal.
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.
405	The request method is not allowed.
500	An internal service error occurred. For details about the error code, see the error code description.
503	The service is unavailable.