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".

Query parameters


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.

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

Request body

The request body contains an instance of Tenant.

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.