Reference documentation and code samples for the Compute V1 Client class Policy.
An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. APolicyis a collection ofbindings. Abindingbinds one or moremembers, or principals, to a singlerole. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). Aroleis a named list of permissions; eachrolecan be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, abindingcan also specify acondition, which is a logical expression that allows access to a resource only if the expression evaluates totrue. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see theIAM documentation.JSON example:{ "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }YAML example:bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3For a description of IAM and its features, see theIAM documentation.
Generated from protobuf messagegoogle.cloud.compute.v1.Policy
Associates a list ofmembers, or principals, with arole. Optionally, may specify aconditionthat determines how and when thebindingsare applied. Each of thebindingsmust contain at least one principal. Thebindingsin aPolicycan refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if thebindingsgrant 50 different roles touser:alice@example.com, and not to any other principal, then you can add another 1,450 principals to thebindingsin thePolicy.
↳ etag
string
etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of theetagin the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetagis returned in the response togetIamPolicy, and systems are expected to put that etag in the request tosetIamPolicyto ensure that their change will be applied to the same version of the policy.Important:If you use IAM Conditions, you must include theetagfield whenever you callsetIamPolicy. If you omit this field, then IAM allows you to overwrite a version3policy with a version1policy, and all of the conditions in the version3policy are lost.
↳ iam_owned
bool
↳ version
int
Specifies the format of the policy. Valid values are0,1, and3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditionsImportant:If you use IAM Conditions, you must include theetagfield whenever you callsetIamPolicy. If you omit this field, then IAM allows you to overwrite a version3policy with a version1policy, and all of the conditions in the version3policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see theIAM documentation.
getAuditConfigs
Specifies cloud audit logging configuration for this policy.
Associates a list ofmembers, or principals, with arole. Optionally, may specify aconditionthat determines how and when thebindingsare applied. Each of thebindingsmust contain at least one principal. Thebindingsin aPolicycan refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if thebindingsgrant 50 different roles touser:alice@example.com, and not to any other principal, then you can add another 1,450 principals to thebindingsin thePolicy.
Associates a list ofmembers, or principals, with arole. Optionally, may specify aconditionthat determines how and when thebindingsare applied. Each of thebindingsmust contain at least one principal. Thebindingsin aPolicycan refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if thebindingsgrant 50 different roles touser:alice@example.com, and not to any other principal, then you can add another 1,450 principals to thebindingsin thePolicy.
etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of theetagin the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetagis returned in the response togetIamPolicy, and systems are expected to put that etag in the request tosetIamPolicyto ensure that their change will be applied to the same version of the policy.Important:If you use IAM Conditions, you must include theetagfield whenever you callsetIamPolicy. If you omit this field, then IAM allows you to overwrite a version3policy with a version1policy, and all of the conditions in the version3policy are lost.
Returns
Type
Description
string
hasEtag
clearEtag
setEtag
etagis used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of theetagin the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetagis returned in the response togetIamPolicy, and systems are expected to put that etag in the request tosetIamPolicyto ensure that their change will be applied to the same version of the policy.Important:If you use IAM Conditions, you must include theetagfield whenever you callsetIamPolicy. If you omit this field, then IAM allows you to overwrite a version3policy with a version1policy, and all of the conditions in the version3policy are lost.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getIamOwned
Generated from protobuf fieldoptional bool iam_owned = 450566203;
Returns
Type
Description
bool
hasIamOwned
clearIamOwned
setIamOwned
Generated from protobuf fieldoptional bool iam_owned = 450566203;
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getVersion
Specifies the format of the policy. Valid values are0,1, and3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditionsImportant:If you use IAM Conditions, you must include theetagfield whenever you callsetIamPolicy. If you omit this field, then IAM allows you to overwrite a version3policy with a version1policy, and all of the conditions in the version3policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see theIAM documentation.
Returns
Type
Description
int
hasVersion
clearVersion
setVersion
Specifies the format of the policy. Valid values are0,1, and3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditionsImportant:If you use IAM Conditions, you must include theetagfield whenever you callsetIamPolicy. If you omit this field, then IAM allows you to overwrite a version3policy with a version1policy, and all of the conditions in the version3policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see theIAM documentation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Compute V1 Client - Class Policy (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.Policy)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.Policy)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.Policy)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.Policy)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.Policy)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.Policy)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.Policy)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.Policy)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.Policy)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.Policy)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.Policy)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.Policy)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.Policy)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.Policy)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.Policy)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.Policy)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.Policy)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.Policy)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.Policy)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.Policy)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.Policy)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.Policy)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.Policy)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.Policy)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.Policy)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.Policy)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.Policy)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.Policy)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.Policy)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.Policy) \nReference documentation and code samples for the Compute V1 Client class Policy.\n\nAn Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** `{ \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 }` **YAML example:** `bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).\n\nGenerated from protobuf message `google.cloud.compute.v1.Policy`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAuditConfigs\n\nSpecifies cloud audit logging configuration for this policy.\n\n### setAuditConfigs\n\nSpecifies cloud audit logging configuration for this policy.\n\n### getBindings\n\nAssociates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.\n\n### setBindings\n\nAssociates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.\n\n### getEtag\n\n`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.\n\n### hasEtag\n\n### clearEtag\n\n### setEtag\n\n`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.\n\n### getIamOwned\n\nGenerated from protobuf field `optional bool iam_owned = 450566203;`\n\n### hasIamOwned\n\n### clearIamOwned\n\n### setIamOwned\n\nGenerated from protobuf field `optional bool iam_owned = 450566203;`\n\n### getVersion\n\nSpecifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: \\* Getting a policy that includes a conditional role binding \\* Adding a conditional role binding to a policy \\* Changing a conditional role binding in a policy \\* Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n### hasVersion\n\n### clearVersion\n\n### setVersion\n\nSpecifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: \\* Getting a policy that includes a conditional role binding \\* Adding a conditional role binding to a policy \\* Changing a conditional role binding in a policy \\* Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."]]