Tenants

List user tenants

client.user.tenants.list(?): SinglePage<TenantListResponse { cdate, customer_id, edate, 10 more } >

GET/user/tenants

ModelsExpand Collapse

TenantListResponse { cdate, customer_id, edate, 10 more }

cdate: string

formatdate-time

customer_id: string | null

edate: string

formatdate-time

tenant_contacts: TenantContacts { email, website }

email?: string

website?: string

tenant_labels: Array<string> | null

tenant_metadata: TenantMetadata { billing_account_type, configuration_account, created_by, 4 more }

billing_account_type?: string

configuration_account?: string

created_by?: string

dns?: DNS { ns_pool }

ns_pool: NSPool { primary, secondary }

primary: string | null

secondary: string | null

flags?: Record<string, string>

innate_account_entitlements?: Array<InnateAccountEntitlement>

allocation: Allocation { type, value }

type: string

value: boolean | number | string | 2 more

One of the following:

boolean

number

string

Record<string, unknown> | null

Array<unknown>

feature: Feature { key }

key: string

tenant_entitlements?: Array<TenantEntitlement>

allocation: Allocation { type, value }

type: string

value: boolean | number | string | 2 more

One of the following:

boolean

number

string

Record<string, unknown> | null

Array<unknown>

feature: Feature { key }

key: string

tenant_name: string

tenant_network: TenantNetwork { choices }

choices?: Record<string, unknown>

tenant_status: string

tenant_tag: string

tenant_type: string

tenant_units: Array<TenantUnit> | null

unit_memberships: Array<UnitMembership> | null

member_metadata: unknown

member_status: string

member_tag: string

unit_metadata: unknown

unit_name: string

unit_status: string

unit_tag: string

ui_flags: UIFlags { show_orgs_ui, show_tenants_ui }

Which top-level dashboard experiences to render for this tenant; both may be true.

show_orgs_ui: boolean

Render the Organizations experience for this tenant.

show_tenants_ui: boolean

Render the legacy Tenants experience for this tenant.