Skip to content
Start here

Tenants

List user tenants
GET/user/tenants
ModelsExpand Collapse
TenantListResponse object { cdate, customer_id, edate, 10 more }
cdate: string
formatdate-time
customer_id: string
edate: string
formatdate-time
tenant_contacts: object { email, website }
email: optional string
website: optional string
tenant_labels: array of string
tenant_metadata: object { billing_account_type, configuration_account, created_by, 4 more }
billing_account_type: optional string
configuration_account: optional string
created_by: optional string
dns: optional object { ns_pool }
ns_pool: object { primary, secondary }
primary: string
secondary: string
flags: optional map[string]
innate_account_entitlements: optional array of object { allocation, feature }
allocation: object { type, value }
type: string
value: boolean or number or string or 2 more
One of the following:
boolean
number
string
map[unknown]
array of unknown
feature: object { key }
key: string
tenant_entitlements: optional array of object { allocation, feature }
allocation: object { type, value }
type: string
value: boolean or number or string or 2 more
One of the following:
boolean
number
string
map[unknown]
array of unknown
feature: object { key }
key: string
tenant_name: string
tenant_network: object { choices }
choices: optional map[unknown]
tenant_status: string
tenant_tag: string
tenant_type: string
tenant_units: array of object { unit_memberships, unit_metadata, unit_name, 2 more }
unit_memberships: array of object { member_metadata, member_status, member_tag }
member_metadata: unknown
member_status: string
member_tag: string
unit_metadata: unknown
unit_name: string
unit_status: string
unit_tag: string
ui_flags: object { 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.