Method: projects.tenants.patch | Identity Platform | Google Cloud Documentation (original) (raw)
- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Update a tenant. Requires write permission on the Tenant resource.
HTTP request
PATCH https://identitytoolkit.googleapis.com/v2/{tenant.name=projects/*/tenants/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
| tenant.name | string Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}" |
Query parameters
| Parameters | |
|---|---|
| updateMask | 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 https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskThis 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](/identity-platform/docs/reference/rest/v2/projects.tenants#Tenant).
Response body
If successful, the response body contains an instance of [Tenant](/identity-platform/docs/reference/rest/v2/projects.tenants#Tenant).
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/identitytoolkithttps://www.googleapis.com/auth/firebasehttps://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.