Method: projects.tenants.patch

Updates specified tenant.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Required during tenant update.

The resource name for a tenant. This is generated by the service when a tenant is created.

The format is "projects/{projectId}/tenants/{tenantId}", for example, "projects/foo/tenants/bar".

Request body

The request body contains data with the following structure:

JSON representation
  "tenant": {
    "name": string,
    "externalId": string,
    "usageType": enum (DataUsageType),
    "keywordSearchableProfileCustomAttributes": [
  "updateMask": string


Required. Client side tenant identifier, used to uniquely identify the tenant.

The maximum number of allowed characters is 255.


enum (DataUsageType)

Indicates whether data owned by this tenant may be used to provide product improvements across other tenants.

Defaults behavior is DataUsageType.ISOLATED if it's unset.



A list of keys of filterable Profile.custom_attributes, whose corresponding stringValues are used in keyword searches. Profiles with stringValues under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and must be surrounded by quotes.


string (FieldMask format)

Strongly recommended for the best service experience.

If updateMask is provided, only the specified fields in tenant are updated. Otherwise all the fields are updated.

A field mask to specify the tenant fields to be updated. Only top level fields of Tenant are supported.

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

Response body

If successful, the response body contains an instance of Tenant.

Authorization Scopes

Requires one of the following OAuth scopes:


For more information, see the Authentication Overview.