Skip to main content

policies

Overview

Namepolicies
TypeResource
Idgoogle.iam.policies

Fields

NameDatatypeDescription
namestringImmutable. The resource name of the Policy, which must be unique. Format: policies/{attachment_point}/denypolicies/{policy_id} The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, /, must be written as %2F. For example, policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID.
displayNamestringA user-specified description of the Policy. This value can be up to 63 characters.
uidstringImmutable. The globally unique ID of the Policy. Assigned automatically when the Policy is created.
rulesarrayA list of rules that specify the behavior of the Policy. All of the rules should be of the kind specified in the Policy.
updateTimestringOutput only. The time when the Policy was last updated.
annotationsobjectA key-value map to store arbitrary metadata for the Policy. Keys can be up to 63 characters. Values can be up to 255 characters.
deleteTimestringOutput only. The time when the Policy was deleted. Empty if the policy is not deleted.
etagstringAn opaque tag that identifies the current version of the Policy. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicyRequest, the value is ignored.
kindstringOutput only. The kind of the Policy. Always contains the value DenyPolicy.
createTimestringOutput only. The time when the Policy was created.

Methods

NameAccessible byRequired ParamsDescription
getSELECTpoliciesId, policiesId1, policiesId2Gets a policy.
list_policiesSELECTpoliciesId, policiesId1Retrieves the policies of the specified kind that are attached to a resource. The response lists only policy metadata. In particular, policy rules are omitted.
create_policyINSERTpoliciesId, policiesId1Creates a policy.
deleteDELETEpoliciesId, policiesId1, policiesId2Deletes a policy. This action is permanent.
_list_policiesEXECpoliciesId, policiesId1Retrieves the policies of the specified kind that are attached to a resource. The response lists only policy metadata. In particular, policy rules are omitted.
updateEXECpoliciesId, policiesId1, policiesId2Updates the specified policy. You can update only the rules and the display name for the policy. To update a policy, you should use a read-modify-write loop: 1. Use GetPolicy to read the current version of the policy. 2. Modify the policy as needed. 3. Use UpdatePolicy to write the updated policy. This pattern helps prevent conflicts between concurrent updates.