Buckets: setIamPolicy

Updates an Identity and Access Management (IAM) policy for the specified bucket.

Required permissions

The authenticated user must have the storage.buckets.setIamPolicy IAM permission to use this method.

Request

HTTP request

PUT https://storage.googleapis.com/storage/v1/b/bucket/iam

In addition to standard query parameters, the following query parameters apply to this method.

To see an example of how to include query parameters in a request, see the JSON API Overview page.

Parameters

Parameter name Value Description
Path parameters
bucket string Name of a bucket.

Request body

In the request body, supply data with the following structure:

{
  "version": int,
  "kind": "storage#policy",
  "resourceId": string,
  "bindings": [
    {
      "role": string,
      "members": [
        string
      ],
      "condition": {
        "title": string,
        "description": string,
        "expression": RFC 3339 format string
      }
    }],
  "etag": string
}
Property name Value Description Notes
version int The IAM policy version. Required to be 3 or greater for buckets with IAM Conditions.
kind string The kind of item this is. For policies, this field is ignored in a request and is "storage#policy" in a response.
resourceId string The ID of the resource to which this policy belongs. The response for this field is of the form "projects/_/buckets/bucket". This field is ignored in a request.
bindings[] list An association between a role, which comes with a set of permissions, and principals that have that role.
bindings[].role string The role that principals have. Two types of roles are supported: standard IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format "roles/storage.specificRole".
See Cloud Storage IAM Roles for a list of available roles.
bindings[].members[] list A collection of principals that have the specified role. For a list of recognized values, see Principal identifiers and Convenience values.
bindings[].condition object

A condition object associated with this binding. Each role binding can only contain one condition.

 writable
bindings[].condition.title string Title of the condition. For example, "expires_end_of_2018".
bindings[].condition.description string Optional description of the condition. For example, "Expires at midnight on 2018-12-31". writable
bindings[].condition.expression string Attribute-based logic expression using a subset of the Common Expression Language (CEL). For example, "request.time < timestamp('2019-01-01T00:00:00Z')".
etag string HTTP 1.1 Entity tag for the policy. Optional. writable

Response

If successful, this method returns a response body with the following structure:

{
  "version": int,
  "kind": "storage#policy",
  "resourceId": string,
  "bindings": [
    {
      "role": string,
      "members": [
        string
      ]
      "condition": {
        "title": string,
        "description": string,
        "expression": RFC 3339 format string
      }
    }
  ],
  "etag": string
}
Property name Value Description Notes
version int The IAM policy version.
kind string The kind of item this is. For policies, this field is ignored in a request and is "storage#policy" in a response.
resourceId string The ID of the resource to which this policy belongs. The response for this field is of the form "projects/_/buckets/bucket". This field is ignored in a request.
bindings[] list An association between a role, which comes with a set of permissions, and principals that have that role.
bindings[].role string The role that principals have. Two types of roles are supported: standard IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format "roles/storage.specificRole".
See Cloud Storage IAM Roles for a list of available roles.
bindings[].members[] list A collection of identifiers for principals that have the specified role. Recognized identifiers are as follows:
  • "allUsers" — A special identifier that represents any entity on the internet.
  • "allAuthenticatedUsers" — A special identifier that represents most authenticated users, including all service accounts. For more information, see IAM overview.
  • "user:emailid" — An email address that represents a specific account. For example, "user:joe@example.com".
  • "serviceAccount:emailid" — An email address that represents a service account. For example, "serviceAccount:my-other-app@appspot.gserviceaccount.com".
  • "group:emailid" — An email address that represents a Google group. For example, "group:admins@example.com".
  • "domain:domain" — A domain name that represents all the users of that domain. For example, "domain:google.com" or "domain:example.com".
  • "projectOwner:projectid" — Owners of the given project. For example, "projectOwner:my-example-project"
  • "projectEditor:projectid" — Editors of the given project. For example, "projectEditor:my-example-project"
  • "projectViewer:projectid" — Viewers of the given project. For example, "projectViewer:my-example-project"
bindings[].condition object

A condition object associated with this binding. Each role binding can only contain one condition.

 optional
bindings[].condition.title string Title of the condition. For example, "expires_end_of_2018".
bindings[].condition.description string Optional description of the condition. For example, "Expires at midnight on 2018-12-31". optional
bindings[].condition.expression string Attribute-based logic expression using a subset of the Common Expression Language (CEL). For example, "request.time < timestamp('2019-01-01T00:00:00Z')".
etag string HTTP 1.1 Entity tag for the policy. writable

For information about status and error codes returned by this API, see the reference page.

Try it!

Use the APIs Explorer below to call this method on live data and see the response.