Method: tenants.patch

Full name: projects.locations.instances.tenants.patch

tenants.patch allows partners to update their tenants. It supports update for AuthMethod and WorkforcePoolProviderId.

HTTP request


PATCH https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{tenant.name}

Path parameters

Parameters
tenant.name

string

Identifier. The resource name of this tenant. Format: projects/{project}/locations/{region}/instances/{instance}/tenants/{tenantId}

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The list of fields to update.

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:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.tenants.update

For more information, see the IAM documentation.