REST Resource: projects.locations.instances.tenants

Resource: Tenant

Tenant represents a tenant of a partner.

JSON representation 
{
  "name": string,
  "tenantGcpProject": string,
  "state": enum (State),
  "displayName": string,
  "customerCode": string,
  "retentionDuration": enum (RetentionDuration),
  "authMethod": enum (AuthMethod),
  "frontendPathConfigs": [
    {
      object (FrontendPathConfig)
    }
  ]
}
Fields
name

string

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

string

Required. Project name of the tenant's BYOP project.
state

enum (State)

Output only. The state of the Tenant.
displayName

string

Required. The display name of the tenant.
customerCode

string

Output only. Customer code associated with the tenant.
retentionDuration

enum (RetentionDuration)

Required. Customer's contractually agreed data retention duration.
authMethod

enum (AuthMethod)

Optional. Auth Method used by tenant
frontendPathConfigs[]

object (FrontendPathConfig)

Optional. Configuration for the tenant's frontend paths.

RetentionDuration

Data retention duration for the instance. LINT.IfChange(instance-retention-duration)

Enums
RETENTION_DURATION_UNSPECIFIED Default retention period (unspecified).
ONE_YEAR ONE_YEAR retention period (365 days).
EIGHTEEN_MONTHS EIGHTEEN_MONTHS is a normalized value.
SIX_MONTHS SIX_MONTHS is a normalized value.
TWO_YEARS TWO_YEARS or 24 months retention
THREE_YEARS 3 YEARS or 36 months retention
FOUR_YEARS 4 YEARS or 48 months retention
FIVE_YEARS 5 YEARS or 60 months retention
THIRTEEN_MONTHS 13 MONTHS of retention
SIXTY_THREE_DAYS 63 DAYS of retention
THREE_MONTHS 3 MONTHS of retention
UNLIMITED Unlimited data retention

AuthMethod

Auth Method of the Tenant.

Enums
AUTH_METHOD_UNSPECIFIED The default value.
WORKFORCE_IDENTITY_FEDERATION Workforce Identity Federation
CLOUD_IDENTITY Cloud Identity

Methods

create

 Allow partners to create a new tenant.

list

 Allow partners to list their tenants.

patch

 UpdateTenant allows partners to update their tenants.