Method: projects.locations.tenants.patch

Update a single tenant.

HTTP request

PATCH https://saasservicemgmt.googleapis.com/v1beta1/{tenant.name=projects/*/locations/*/tenants/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
tenant.name

string

Identifier. The resource name (full URI of the resource) following the standard naming scheme:

"projects/{project}/locations/{location}/tenants/{tenant}"

Query parameters

Parameters
validateOnly

boolean

If "validateOnly" is set to true, the service will try to validate that this request would succeed, but will not actually make changes.
requestId

string

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask

string (FieldMask format)

Field mask is used to specify the fields to be overwritten in the Tenant resource by the update.

The fields specified in the updateMask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.

If the user does not provide a mask then all fields in the Tenant will be overwritten.

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 the following OAuth scope:

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

For more information, see the Authentication Overview.