REST Resource: projects.tenants

Stay organized with collections Save and categorize content based on your preferences.

Resource: Tenant

A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups.

JSON representation
{
  "name": string,
  "externalId": string
}
Fields
name

string

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

externalId

string

Required. Client side tenant identifier, used to uniquely identify the tenant.

The maximum number of allowed characters is 255.

Methods

completeQuery

Completes the specified prefix with keyword suggestions.

create

Creates a new tenant entity.

delete

Deletes specified tenant.

get

Retrieves specified tenant.

list

Lists all tenants associated with the project.

patch

Updates specified tenant.