projects

PATCH /v1/projects/{projectsId}/locations/{locationsId}/taxonomies/{taxonomiesId}

Updates a taxonomy, including its display name, description, and activated policy types.

Request

Path parameters

projectsIdstring required
locationsIdstring required
taxonomiesIdstring required

Query parameters

updateMaskstring google-fieldmask

Specifies fields to update. If not set, defaults to all fields you can update. For more information, see [FieldMask] (https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).

Request body

activatedPolicyTypesstring[]

Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

descriptionstring

Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.

displayNamestring

Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.

namestring

Identifier. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.

policyTagCountinteger

Output only. Number of policy tags in this taxonomy.

Response

Successful response

activatedPolicyTypesstring[]

Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list.

descriptionstring

Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8.

displayNamestring

Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization.

namestring

Identifier. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs.

policyTagCountinteger

Output only. Number of policy tags in this taxonomy.

Changes

No recorded changes to this operation across all 5 revisions of this API.