Help Center> Organizations> API Reference> API> Managing Policies> Updating a Policy

Updated on 2024-03-15 GMT+08:00

View PDF

Updating a Policy

Function

This API is used to update the name, description, or content of a policy. If no parameter is provided, the policy remains unchanged. A policy's type cannot be changed. This API can be called only from the organization's management account.

URI

PATCH /v1/organizations/policies/{policy_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
policy_id	Yes	String	Unique ID of the policy. Maximum: 130

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Minimum: 1
X-Language	No	String	Language of the returned results. Enumeration values: zh-cn en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
content	No	String	Policy text content to be added to the new policy. Minimum: 0 Maximum: 20000
description	No	String	Optional description to be assigned to the policy. Maximum: 512
name	No	String	Name to be assigned to the policy. Minimum: 1 Maximum: 64

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
policy	PolicyDto object	Details about a policy.

**Table 5** PolicyDto
Parameter	Type	Description
content	String	Text content of the policy. Minimum: 0 Maximum: 20000
policy_summary	PolicySummaryDto object	Information about a policy (policy content not included).

**Table 6** PolicySummaryDto
Parameter	Type	Description
is_builtin	Boolean	A boolean value indicating whether the specified policy is a system policy. If the value is true, the policy is a system policy. You can attach the policy to roots, OUs, or accounts, but you cannot edit it.
description	String	Description of the policy. Maximum: 512
id	String	Unique ID of the policy. Minimum: 1 Maximum: 130
urn	String	Uniform resource name of the policy. Minimum: 1 Maximum: 1500
name	String	Name of the policy. Minimum: 1 Maximum: 64
type	String	Policy type. It can be service_control_policy or tag_policy. Minimum: 1 Maximum: 64

Example Requests

Updating a policy

PATCH https://{hostname}/v1/organizations/policies/{policy_id}

{
  "content" : "{\"Version\":\"5.0\",\"Statement\":[{\"Sid\":\"Statement1\",\"Effect\":\"Allow\",\"Action\":[\"*\"],\"Resource\":[\"*\"]}]}",
  "description" : "newdesc",
  "name" : "auto09231619598990t1HPolicyName"
}

Example Responses

Status code: 200

Successful.

{
  "policy" : {
    "content" : "{\"Version\":\"5.0\",\"Statement\":[{\"Sid\":\"Statement1\",\"Effect\":\"Allow\",\"Action\":[\"*\"],\"Resource\":[\"*\"]}]}",
    "policy_summary" : {
      "is_builtin" : false,
      "description" : "newdesc",
      "id" : "p-xce633owqm0o1c929wno7l850z2rdr4m",
      "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:policy:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/service_control_policy/p-b4wpejd02o66g0pvfinvsatp4t9krfum",
      "name" : "auto09231619598990t1HPolicyName",
      "type" : "service_control_policy"
    }
  }
}