Stay organized with collections Save and categorize content based on your preferences.
Requires authorization
Sets the access control policy on the specified resource. Replaces any existing policy. Try it now.
Request HTTP requestPOST https://www.googleapis.com/deploymentmanager/v2/projects/project/global/deployments/resource/setIamPolicyParameters Parameter name Value Description Path parameters
project string Project ID for this request. resource string Name or id of the resource for this request. Authorization
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).
Scopehttps://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/ndev.cloudman Request body
In the request body, supply data with the following structure:
{
"policy": {
"version": integer,
"bindings": [
{
"role": string,
"members": [
string
],
"condition": {
"expression": string,
"title": string,
"description": string,
"location": string
}
}
],
"auditConfigs": [
{
"service": string,
"exemptedMembers": [
string
],
"auditLogConfigs": [
{
"logType": string,
"exemptedMembers": [
string
]
}
]
}
],
"rules": [
{
"description": string,
"permissions": [
string
],
"action": string,
"ins": [
string
],
"notIns": [
string
],
"conditions": [
{
"iam": string,
"sys": string,
"svc": string,
"op": string,
"values": [
string
]
}
],
"logConfigs": [
{
"counter": {
"metric": string,
"field": string
},
"dataAccess": {
"logMode": string
},
"cloudAudit": {
"logName": string,
"authorizationLoggingOptions": {
"permissionType": string
}
}
}
]
}
],
"etag": bytes,
"iamOwned": boolean
},
"bindings": [
{
"role": string,
"members": [
string
],
"condition": {
"expression": string,
"title": string,
"description": string,
"location": string
}
}
],
"etag": bytes
} Property name Value Description Notes bindings[] list Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings. bindings[].role string Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. bindings[].members[] list Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` .
* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
* `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
etag bytes Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag. bindings[].condition nested object The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. bindings[].condition.expression string Textual representation of an expression in Common Expression Language syntax.
The application context of the containing message determines which well-known feature set of CEL is supported.
bindings[].condition.title string An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. bindings[].condition.description string An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. bindings[].condition.location string An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. policy nested object REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them. policy.version integer Deprecated. policy.bindings[] list Associates a list of `members` to a `role`. `bindings` with no members will result in an error. policy.bindings[].role string Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. policy.bindings[].members[] list Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` .
* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
* `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
policy.bindings[].condition nested object The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. policy.bindings[].condition.expression string Textual representation of an expression in Common Expression Language syntax.
The application context of the containing message determines which well-known feature set of CEL is supported.
policy.bindings[].condition.title string An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. policy.bindings[].condition.description string An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. policy.bindings[].condition.location string An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. policy.auditConfigs[] list Specifies cloud audit logging configuration for this policy. policy.auditConfigs[].service string Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. policy.auditConfigs[].exemptedMembers[] list policy.auditConfigs[].auditLogConfigs[] list The configuration for logging of each type of permission. policy.auditConfigs[].auditLogConfigs[].logType string The log type that this config enables. policy.auditConfigs[].auditLogConfigs[].exemptedMembers[] list Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. policy.rules[] list If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. policy.rules[].description string Human-readable description of the rule. policy.rules[].permissions[] list A permission is a string of form ' . . ' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. policy.rules[].action string Required policy.rules[].ins[] list If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. policy.rules[].notIns[] list If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. policy.rules[].conditions[] list Additional restrictions that must be met. All conditions must pass for the rule to match. policy.rules[].conditions[].iam string Trusted attributes supplied by the IAM system. policy.rules[].conditions[].sys string Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. policy.rules[].conditions[].svc string Trusted attributes discharged by the service. policy.rules[].conditions[].op string An operator to apply the subject with. policy.rules[].conditions[].values[] list The objects of the condition. policy.rules[].logConfigs[] list The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. policy.rules[].logConfigs[].counter nested object Counter options. policy.rules[].logConfigs[].counter.metric string The metric to update. policy.rules[].logConfigs[].counter.field string The field value to attribute. policy.rules[].logConfigs[].dataAccess nested object Data access options. policy.rules[].logConfigs[].dataAccess.logMode string Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now.
NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152).
policy.rules[].logConfigs[].cloudAudit nested object Cloud audit options. policy.rules[].logConfigs[].cloudAudit.logName string The log_name to populate in the Cloud Audit Record. policy.rules[].logConfigs[].cloudAudit.authorizationLoggingOptions nested object Information used by the Cloud Audit Logging pipeline. policy.rules[].logConfigs[].cloudAudit.authorizationLoggingOptions.permissionType string The type of the permission that was checked. policy.etag bytes `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.
If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
policy.iamOwned boolean Response
If successful, this method returns a response body with the following structure:
{
"version": integer,
"bindings": [
{
"role": string,
"members": [
string
],
"condition": {
"expression": string,
"title": string,
"description": string,
"location": string
}
}
],
"auditConfigs": [
{
"service": string,
"exemptedMembers": [
string
],
"auditLogConfigs": [
{
"logType": string,
"exemptedMembers": [
string
]
}
]
}
],
"rules": [
{
"description": string,
"permissions": [
string
],
"action": string,
"ins": [
string
],
"notIns": [
string
],
"conditions": [
{
"iam": string,
"sys": string,
"svc": string,
"op": string,
"values": [
string
]
}
],
"logConfigs": [
{
"counter": {
"metric": string,
"field": string
},
"dataAccess": {
"logMode": string
},
"cloudAudit": {
"logName": string,
"authorizationLoggingOptions": {
"permissionType": string
}
}
}
]
}
],
"etag": bytes,
"iamOwned": boolean
} Property name Value Description Notes version integer Deprecated. bindings[] list Associates a list of `members` to a `role`. `bindings` with no members will result in an error. bindings[].role string Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. bindings[].members[] list Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:
* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.
* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` .
* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.
* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.
* `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
auditConfigs[] list Specifies cloud audit logging configuration for this policy. auditConfigs[].service string Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. auditConfigs[].exemptedMembers[] list auditConfigs[].auditLogConfigs[] list The configuration for logging of each type of permission. auditConfigs[].auditLogConfigs[].logType string The log type that this config enables. auditConfigs[].auditLogConfigs[].exemptedMembers[] list Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][]. rules[] list If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. rules[].description string Human-readable description of the rule. rules[].permissions[] list A permission is a string of form ' . . ' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs. rules[].action string Required rules[].ins[] list If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries. rules[].notIns[] list If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. rules[].conditions[] list Additional restrictions that must be met. All conditions must pass for the rule to match. rules[].conditions[].iam string Trusted attributes supplied by the IAM system. rules[].conditions[].sys string Trusted attributes supplied by any service that owns resources and uses the IAM system for access control. rules[].conditions[].svc string Trusted attributes discharged by the service. rules[].conditions[].op string An operator to apply the subject with. rules[].conditions[].values[] list The objects of the condition. rules[].logConfigs[] list The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action. rules[].logConfigs[].counter nested object Counter options. rules[].logConfigs[].counter.metric string The metric to update. rules[].logConfigs[].counter.field string The field value to attribute. etag bytes `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.
If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
iamOwned boolean bindings[].condition nested object The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently. bindings[].condition.expression string Textual representation of an expression in Common Expression Language syntax.
The application context of the containing message determines which well-known feature set of CEL is supported.
bindings[].condition.title string An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. bindings[].condition.description string An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. bindings[].condition.location string An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. rules[].logConfigs[].dataAccess nested object Data access options. rules[].logConfigs[].dataAccess.logMode string Whether Gin logging should happen in a fail-closed manner at the caller. This is relevant only in the LocalIAM implementation, for now.
NOTE: Logging to Gin in a fail-closed manner is currently unsupported while work is being done to satisfy the requirements of go/345. Currently, setting LOG_FAIL_CLOSED mode will have no effect, but still exists because there is active work being done to support it (b/115874152).
rules[].logConfigs[].cloudAudit nested object Cloud audit options. rules[].logConfigs[].cloudAudit.logName string The log_name to populate in the Cloud Audit Record. rules[].logConfigs[].cloudAudit.authorizationLoggingOptions nested object Information used by the Cloud Audit Logging pipeline. rules[].logConfigs[].cloudAudit.authorizationLoggingOptions.permissionType string The type of the permission that was checked. Try it!
Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-30 UTC.
[[["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-04-30 UTC."],[[["This endpoint allows you to set the access control policy for a specified resource, replacing any existing policy."],["The HTTP request method is POST, and the URL includes the project ID and resource name or ID as path parameters."],["Authorization for this endpoint requires either the `https://www.googleapis.com/auth/cloud-platform` or `https://www.googleapis.com/auth/ndev.cloudman` scopes."],["The request body must contain a 'policy' object, which can include bindings, audit configurations, and rules, to define access control."],["The response body mirrors the structure of the 'policy' object in the request body, reflecting the applied access control configurations, including any provided etag and iamOwned values."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4