Skip to main content
Version: 2025.11

Tenant

Description: Class representing a tenant object. This class is used to store information about tenants, combining what’s stored in the registry and what’s stored in the authn provider. Attributes ———- provider_tenant_id (str): The provider’s tenant id. provider_name (str): The provider’s name/type (e.g. Zitadel or Okta). name (str): The tenant name (comes from ProviderTenant object). state (str): The tenant state (comes from ProviderTenant object). primary_domain (str): The primary domain used by the tenant (comes from ProviderTenant object). object_store_id (UUID): The object store id associated with the tenant. If None the default object store is used.

Attributes

NameTypeDescription
idStrictStr
createddatetime.datetime
provider_tenant_idStrictStr
provider_nameStrictStr
stateOptional[StrictStr]
primary_domainOptional[StrictStr]
object_store_idOptional[StrictStr]
nameOptional[StrictStr]
labelOptional[StrictStr]

Methods

NameDescription
to_strReturn the string representation of the model using field aliases.
to_jsonReturn the JSON string representation of the model using field aliases.
from_jsonCreate an instance of the model from a JSON string.
to_dictReturn the dictionary representation of the model using field aliases.
from_dictCreate an instance of Tenant from a dict