Skip to content
Start here

Tenants

List user tenants
user.tenants.list() -> SyncSinglePage[TenantListResponse]
GET/user/tenants
ModelsExpand Collapse
class TenantListResponse: …
cdate: datetime
formatdate-time
customer_id: Optional[str]
edate: datetime
formatdate-time
tenant_contacts: TenantContacts
email: Optional[str]
website: Optional[str]
tenant_labels: Optional[List[str]]
tenant_metadata: TenantMetadata
billing_account_type: Optional[str]
configuration_account: Optional[str]
created_by: Optional[str]
dns: Optional[TenantMetadataDNS]
ns_pool: TenantMetadataDNSNSPool
primary: Optional[str]
secondary: Optional[str]
flags: Optional[Dict[str, str]]
innate_account_entitlements: Optional[List[TenantMetadataInnateAccountEntitlement]]
allocation: TenantMetadataInnateAccountEntitlementAllocation
type: str
value: Union[bool, float, str, 2 more]
One of the following:
bool
float
str
Optional[Dict[str, object]]
List[object]
feature: TenantMetadataInnateAccountEntitlementFeature
key: str
tenant_entitlements: Optional[List[TenantMetadataTenantEntitlement]]
allocation: TenantMetadataTenantEntitlementAllocation
type: str
value: Union[bool, float, str, 2 more]
One of the following:
bool
float
str
Optional[Dict[str, object]]
List[object]
feature: TenantMetadataTenantEntitlementFeature
key: str
tenant_name: str
tenant_network: TenantNetwork
choices: Optional[Dict[str, object]]
tenant_status: str
tenant_tag: str
tenant_type: str
tenant_units: Optional[List[TenantUnit]]
unit_memberships: Optional[List[TenantUnitUnitMembership]]
member_metadata: object
member_status: str
member_tag: str
unit_metadata: object
unit_name: str
unit_status: str
unit_tag: str
ui_flags: UIFlags

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

show_orgs_ui: bool

Render the Organizations experience for this tenant.

show_tenants_ui: bool

Render the legacy Tenants experience for this tenant.