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)
    }
  ],
  "provisioningFlow": enum (ProvisioningFlow),
  "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.
provisioningFlow

enum (ProvisioningFlow)

Optional. The provisioning flow of the tenant.
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

ProvisioningFlow

Provisioning flow.

Enums
PROVISIONING_FLOW_UNSPECIFIED Unspecified provisioning flow.
BACKSTORY_API_PARITY Provisioning flow triggered to have parity with Backstory API.
TENANT_ATTRIBUTION Provisioning flow triggered with tenant attribution.

Methods

create

 Provisions a new tenant under the specified partner/MSSP parent resource.

list

 Allow partners to list their tenants.

patch

 UpdateTenant allows partners to update their tenants.