REST Resource: projects.locations.taxonomies.policyTags

Resource: PolicyTag

Denotes one policy tag in a taxonomy, for example, SSN.

Policy tags can be defined in a hierarchy. For example:

+ Geolocation
  + LatLong
  + City
  + ZipCode

Where the "Geolocation" policy tag contains three children.

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "parentPolicyTag": string,
  "childPolicyTags": [
    string
  ]
}
Fields
name

string

Output only. Resource name of this policy tag in the URL format.

The policy tag manager generates unique taxonomy IDs and policy tag IDs.

displayName

string

Required. User-defined name of this policy tag.

The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8.

description

string

Description of this policy tag. 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.

parentPolicyTag

string

Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string.

For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty.

childPolicyTags[]

string

Output only. Resource names of child policy tags of this policy tag.

Methods

create

Creates a policy tag in a taxonomy.

delete

Deletes a policy tag together with the following:

  • All of its descendant policy tags, if any
  • Policies associated with the policy tag and its descendants
  • References from BigQuery table schema of the policy tag and its descendants

get

Gets a policy tag.

getIamPolicy

Gets the IAM policy for a policy tag or a taxonomy.

list

Lists all policy tags in a taxonomy.

patch

Updates a policy tag, including its display name, description, and parent policy tag.

setIamPolicy

Sets the IAM policy for a policy tag or a taxonomy.

testIamPermissions

Returns your permissions on a specified policy tag or taxonomy.