Method: projects.locations.collections.setCollectionAcl

Sets the access control policy for the collection. Replaces any existing policy.

HTTP request

POST https://contentwarehouse.googleapis.com/v1/{name}:setCollectionAcl

Path parameters

Parameters
name

string

Required. The name of the collection for which the policy is being set. projects/{projectNumber}/locations/{location}/collections/{documentId}. It takes the form projects/{project}/locations/{location}/collections/{collection}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "policy": {
    object (Policy)
  },
  "requestMetadata": {
    object (RequestMetadata)
  }
}
Fields
policy

object (Policy)

Required. REQUIRED: The complete policy to be applied to the collection. The size of the policy is limited to a few 10s of KB.

requestMetadata

object (RequestMetadata)

The meta information collected about the end user, used to enforce access control for the service.

Response body

If successful, the response body contains data with the following structure:

Response message for CollectionService.SetAcl.

JSON representation
{
  "policy": {
    object (Policy)
  },
  "metadata": {
    object (ResponseMetadata)
  }
}
Fields
policy

object (Policy)

The policy created for the Collection.

metadata

object (ResponseMetadata)

Additional information for the API invocation, such as the request tracking id.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • contentwarehouse.collections.setIamPolicy

For more information, see the IAM documentation.