REST Resource: projects.tenants

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 profiles. Customer may create multiple tenants to provide data isolation for different groups.

JSON representation 
{
  "name": string,
  "externalId": string,
  "usageType": enum (DataUsageType),
  "keywordSearchableProfileCustomAttributes": [
    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.
usageType

enum (DataUsageType)

Indicates whether data owned by this tenant may be used to provide product improvements across other tenants.

Defaults behavior is DataUsageType.ISOLATED if it's unset.
keywordSearchableProfileCustomAttributes[]

string

A list of keys of filterable Profile.custom_attributes, whose corresponding stringValues are used in keyword searches. Profiles with stringValues under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and must be surrounded by quotes.

DataUsageType

Enum that represents how user data owned by the tenant is used.

Enums
DATA_USAGE_TYPE_UNSPECIFIED Default value.
AGGREGATED Data owned by this tenant is used to improve search/recommendation quality across tenants.
ISOLATED Data owned by this tenant is used to improve search/recommendation quality for this tenant only.

Methods

complete

 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.