Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

Method: customers.customerUserAccesses.mutate

Updates, removes permission of a user on a given customer. Operation statuses are returned.

List of thrown errors: AuthenticationError AuthorizationError CustomerUserAccessError FieldMaskError HeaderError InternalError MutateError QuotaError RequestError

HTTP request

POST https://googleads.googleapis.com/v8/customers/{customerId}/customerUserAccesses:mutate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customerId

string

Required. The ID of the customer being modified.

Request body

The request body contains data with the following structure:

JSON representation
{
  "operation": {
    object (CustomerUserAccessOperation)
  }
}
Fields
operation

object (CustomerUserAccessOperation)

Required. The operation to perform on the customer

Response body

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

Response message for customer user access mutate.

JSON representation
{
  "result": {
    object (MutateCustomerUserAccessResult)
  }
}
Fields
result

object (MutateCustomerUserAccessResult)

Result for the mutate.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/adwords

For more information, see the OAuth 2.0 Overview.

CustomerUserAccessOperation

A single operation (update, remove) on customer user access.

JSON representation
{
  "updateMask": string,

  // Union field operation can be only one of the following:
  "update": {
    object (CustomerUserAccess)
  },
  "remove": string
  // End of list of possible types for union field operation.
}
Fields
updateMask

string (FieldMask format)

FieldMask that determines which resource fields are modified in an update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Union field operation. The mutate operation. operation can be only one of the following:
update

object (CustomerUserAccess)

Update operation: The customer user access is expected to have a valid resource name.

remove

string

Remove operation: A resource name for the removed access is expected, in this format:

customers/{customerId}/customerUserAccesses/{CustomerUserAccess.user_id}

MutateCustomerUserAccessResult

The result for the customer user access mutate.

JSON representation
{
  "resourceName": string
}
Fields
resourceName

string

Returned for successful operations.