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)
    }
  ],
  "billingAccount": string
}
Fields
name

string

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

tenantGcpProject

string

Required. Project name of the tenant's BYOP project. Format: projects/{projectId} or projects/{projectNumber}

state

enum (State)

Output only. The state of the Tenant.

displayName

string

Required. The display name of the tenant.

customerCode

string

Required. Customer code associated with the tenant.

retentionDuration

enum (RetentionDuration)

Required. Customer's contractually agreed data retention duration.

authMethod

enum (AuthMethod)

Required. Auth Method used by tenant

frontendPathConfigs[]

object (FrontendPathConfig)

Required. Configuration for the tenant's frontend paths.

billingAccount

string

Required. The billing account ID of the customer.

AuthMethod

Auth Method of the Tenant.

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