Tenant#

class Tenant[source]#

The JSON representation of a tenant.

id: str#

The id of the tenant

name: str#

The name of the tenant

sso_provider_id: Optional[str]#

Maybe the id of the SSO provider connected to this tenant.

statistics: Optional[TenantStatistics]#

Maybe the statistics of this tenant, if requested and if you have the permission to see it.

abbreviated_name: Optional[str]#

The short name (or names) of the tenant. This is used to make searching for tenants by end users easier.

order_category: int#

This value determines how the tenant should be ordered. Tenants should first be ordered from highest order_category to lowest, and then by name.

is_hidden: bool#

This value states whether the tenant should be hidden from listing if the user is not allowed to see hidden tenants.

netloc: str#

The netloc this tenant is hosted on.