# Cloud Storage JSON API . defaultObjectAccessControls

## Instance Methods

Permanently deletes the default object ACL entry for the specified entity on the specified bucket.

Returns the default object ACL entry for the specified entity on the specified bucket.

Creates a new default object ACL entry on the specified bucket.

Retrieves default object ACL entries on the specified bucket.

Patches a default object ACL entry on the specified bucket.

Updates a default object ACL entry on the specified bucket.

### Method Details

`delete(bucket, entity, provisionalUserProject=None, userProject=None)`

    Permanently deletes the default object ACL entry for the specified entity on the specified bucket.

    Args:
      bucket: string, Name of a bucket. (required)
      entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
      provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.
      userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

`get(bucket, entity, provisionalUserProject=None, userProject=None)`

    Returns the default object ACL entry for the specified entity on the specified bucket.

    Args:
      bucket: string, Name of a bucket. (required)
      entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
      provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.
      userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

    Returns:
      An object of the form:

        { # An access-control entry.
        "bucket": "A String", # The name of the bucket.
        "domain": "A String", # The domain associated with the entity, if any.
        "email": "A String", # The email address associated with the entity, if any.
        "entity": "A String", # The entity holding the permission, in one of the following forms:
            # - user-userId
            # - user-email
            # - group-groupId
            # - group-email
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "entityId": "A String", # The ID for the entity, if any.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "generation": "A String", # The content generation of the object, if applied to an object.
        "id": "A String", # The ID of the access-control entry.
        "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
        "object": "A String", # The name of the object, if applied to an object.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "role": "A String", # The access permission for the entity.
        "selfLink": "A String", # The link to this access-control entry.
      }

`insert(bucket, body=None, provisionalUserProject=None, userProject=None)`

    Creates a new default object ACL entry on the specified bucket.

    Args:
      bucket: string, Name of a bucket. (required)
      body: object, The request body.
        The object takes the form of:

    { # An access-control entry.
      "bucket": "A String", # The name of the bucket.
      "domain": "A String", # The domain associated with the entity, if any.
      "email": "A String", # The email address associated with the entity, if any.
      "entity": "A String", # The entity holding the permission, in one of the following forms:
          # - user-userId
          # - user-email
          # - group-groupId
          # - group-email
          # - domain-domain
          # - project-team-projectId
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "entityId": "A String", # The ID for the entity, if any.
      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
      "generation": "A String", # The content generation of the object, if applied to an object.
      "id": "A String", # The ID of the access-control entry.
      "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
      "object": "A String", # The name of the object, if applied to an object.
      "projectTeam": { # The project team associated with the entity, if any.
        "projectNumber": "A String", # The project number.
        "team": "A String", # The team.
      },
      "role": "A String", # The access permission for the entity.
      "selfLink": "A String", # The link to this access-control entry.
    }

      provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.
      userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

    Returns:
      An object of the form:

        { # An access-control entry.
        "bucket": "A String", # The name of the bucket.
        "domain": "A String", # The domain associated with the entity, if any.
        "email": "A String", # The email address associated with the entity, if any.
        "entity": "A String", # The entity holding the permission, in one of the following forms:
            # - user-userId
            # - user-email
            # - group-groupId
            # - group-email
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "entityId": "A String", # The ID for the entity, if any.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "generation": "A String", # The content generation of the object, if applied to an object.
        "id": "A String", # The ID of the access-control entry.
        "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
        "object": "A String", # The name of the object, if applied to an object.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "role": "A String", # The access permission for the entity.
        "selfLink": "A String", # The link to this access-control entry.
      }

`list(bucket, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, provisionalUserProject=None, userProject=None)`

    Retrieves default object ACL entries on the specified bucket.

    Args:
      bucket: string, Name of a bucket. (required)
      ifMetagenerationMatch: string, If present, only return default ACL listing if the bucket's current metageneration matches this value.
      ifMetagenerationNotMatch: string, If present, only return default ACL listing if the bucket's current metageneration does not match the given value.
      provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.
      userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

    Returns:
      An object of the form:

        { # An access-control list.
        "items": [ # The list of items.
          { # An access-control entry.
            "bucket": "A String", # The name of the bucket.
            "domain": "A String", # The domain associated with the entity, if any.
            "email": "A String", # The email address associated with the entity, if any.
            "entity": "A String", # The entity holding the permission, in one of the following forms:
                # - user-userId
                # - user-email
                # - group-groupId
                # - group-email
                # - domain-domain
                # - project-team-projectId
                # - allUsers
                # - allAuthenticatedUsers Examples:
                # - The user liz@example.com would be user-liz@example.com.
                # - The group example@googlegroups.com would be group-example@googlegroups.com.
                # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
            "entityId": "A String", # The ID for the entity, if any.
            "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
            "generation": "A String", # The content generation of the object, if applied to an object.
            "id": "A String", # The ID of the access-control entry.
            "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
            "object": "A String", # The name of the object, if applied to an object.
            "projectTeam": { # The project team associated with the entity, if any.
              "projectNumber": "A String", # The project number.
              "team": "A String", # The team.
            },
            "role": "A String", # The access permission for the entity.
            "selfLink": "A String", # The link to this access-control entry.
          },
        ],
        "kind": "storage#objectAccessControls", # The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
      }

`patch(bucket, entity, body=None, provisionalUserProject=None, userProject=None)`

    Patches a default object ACL entry on the specified bucket.

    Args:
      bucket: string, Name of a bucket. (required)
      entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
      body: object, The request body.
        The object takes the form of:

    { # An access-control entry.
      "bucket": "A String", # The name of the bucket.
      "domain": "A String", # The domain associated with the entity, if any.
      "email": "A String", # The email address associated with the entity, if any.
      "entity": "A String", # The entity holding the permission, in one of the following forms:
          # - user-userId
          # - user-email
          # - group-groupId
          # - group-email
          # - domain-domain
          # - project-team-projectId
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "entityId": "A String", # The ID for the entity, if any.
      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
      "generation": "A String", # The content generation of the object, if applied to an object.
      "id": "A String", # The ID of the access-control entry.
      "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
      "object": "A String", # The name of the object, if applied to an object.
      "projectTeam": { # The project team associated with the entity, if any.
        "projectNumber": "A String", # The project number.
        "team": "A String", # The team.
      },
      "role": "A String", # The access permission for the entity.
      "selfLink": "A String", # The link to this access-control entry.
    }

      provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.
      userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

    Returns:
      An object of the form:

        { # An access-control entry.
        "bucket": "A String", # The name of the bucket.
        "domain": "A String", # The domain associated with the entity, if any.
        "email": "A String", # The email address associated with the entity, if any.
        "entity": "A String", # The entity holding the permission, in one of the following forms:
            # - user-userId
            # - user-email
            # - group-groupId
            # - group-email
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "entityId": "A String", # The ID for the entity, if any.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "generation": "A String", # The content generation of the object, if applied to an object.
        "id": "A String", # The ID of the access-control entry.
        "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
        "object": "A String", # The name of the object, if applied to an object.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "role": "A String", # The access permission for the entity.
        "selfLink": "A String", # The link to this access-control entry.
      }

`update(bucket, entity, body=None, provisionalUserProject=None, userProject=None)`

    Updates a default object ACL entry on the specified bucket.

    Args:
      bucket: string, Name of a bucket. (required)
      entity: string, The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. (required)
      body: object, The request body.
        The object takes the form of:

    { # An access-control entry.
      "bucket": "A String", # The name of the bucket.
      "domain": "A String", # The domain associated with the entity, if any.
      "email": "A String", # The email address associated with the entity, if any.
      "entity": "A String", # The entity holding the permission, in one of the following forms:
          # - user-userId
          # - user-email
          # - group-groupId
          # - group-email
          # - domain-domain
          # - project-team-projectId
          # - allUsers
          # - allAuthenticatedUsers Examples:
          # - The user liz@example.com would be user-liz@example.com.
          # - The group example@googlegroups.com would be group-example@googlegroups.com.
          # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
      "entityId": "A String", # The ID for the entity, if any.
      "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
      "generation": "A String", # The content generation of the object, if applied to an object.
      "id": "A String", # The ID of the access-control entry.
      "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
      "object": "A String", # The name of the object, if applied to an object.
      "projectTeam": { # The project team associated with the entity, if any.
        "projectNumber": "A String", # The project number.
        "team": "A String", # The team.
      },
      "role": "A String", # The access permission for the entity.
      "selfLink": "A String", # The link to this access-control entry.
    }

      provisionalUserProject: string, The project to be billed for this request if the target bucket is requester-pays bucket.
      userProject: string, The project to be billed for this request. Required for Requester Pays buckets.

    Returns:
      An object of the form:

        { # An access-control entry.
        "bucket": "A String", # The name of the bucket.
        "domain": "A String", # The domain associated with the entity, if any.
        "email": "A String", # The email address associated with the entity, if any.
        "entity": "A String", # The entity holding the permission, in one of the following forms:
            # - user-userId
            # - user-email
            # - group-groupId
            # - group-email
            # - domain-domain
            # - project-team-projectId
            # - allUsers
            # - allAuthenticatedUsers Examples:
            # - The user liz@example.com would be user-liz@example.com.
            # - The group example@googlegroups.com would be group-example@googlegroups.com.
            # - To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
        "entityId": "A String", # The ID for the entity, if any.
        "etag": "A String", # HTTP 1.1 Entity tag for the access-control entry.
        "generation": "A String", # The content generation of the object, if applied to an object.
        "id": "A String", # The ID of the access-control entry.
        "kind": "storage#objectAccessControl", # The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
        "object": "A String", # The name of the object, if applied to an object.
        "projectTeam": { # The project team associated with the entity, if any.
          "projectNumber": "A String", # The project number.
          "team": "A String", # The team.
        },
        "role": "A String", # The access permission for the entity.
        "selfLink": "A String", # The link to this access-control entry.
      }