TenantIdDescription interface

Tenant Id information.

Properties

country

Country/region name of the address for the tenant.

countryCode

Country/region abbreviation for the tenant.

defaultDomain

The default domain for the tenant.

displayName

The display name of the tenant.

domains

The list of domains for the tenant.

id

The fully qualified ID of the tenant. For example, /tenants/8d65815f-a5b6-402f-9298-045155da7d74

tenantBrandingLogoUrl

The tenant's branding logo URL. Only available for 'Home' tenant category.

tenantCategory

Category of the tenant.

tenantId

The tenant ID. For example, 8d65815f-a5b6-402f-9298-045155da7d74

tenantType

The tenant type. Only available for 'Home' tenant category.

Property Details

country

Country/region name of the address for the tenant.

country?: string

Property Value

string

countryCode

Country/region abbreviation for the tenant.

countryCode?: string

Property Value

string

defaultDomain

The default domain for the tenant.

defaultDomain?: string

Property Value

string

displayName

The display name of the tenant.

displayName?: string

Property Value

string

domains

The list of domains for the tenant.

domains?: string[]

Property Value

string[]

id

The fully qualified ID of the tenant. For example, /tenants/8d65815f-a5b6-402f-9298-045155da7d74

id?: string

Property Value

string

tenantBrandingLogoUrl

The tenant's branding logo URL. Only available for 'Home' tenant category.

tenantBrandingLogoUrl?: string

Property Value

string

tenantCategory

Category of the tenant.

tenantCategory?: TenantCategory

Property Value

tenantId

The tenant ID. For example, 8d65815f-a5b6-402f-9298-045155da7d74

tenantId?: string

Property Value

string

tenantType

The tenant type. Only available for 'Home' tenant category.

tenantType?: string

Property Value

string