Method: projects.tenants.patch

Update a tenant. Requires write permission on the Tenant resource.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}"

Query parameters


string (FieldMask format)

If provided, only update fields set in the update mask. Otherwise, all settable fields will be updated. For the FieldMask definition, see

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.