Tenant
#TenantController
Overview
Description
Path /v2/tenants
Handles all requests regarding tenants: creating, updating, deleting.
Tenant JSON object
An example for a tenant json object with id 0L.
Fields
name : tenant name (must be unique within roomle)
label : tenant label (used in the UI and email)
active : active/inactive tenant
showLanguageSwitch : show language switch
defaultLanguage : tenant default language
authenticationRequired : toggles authentication
visibility : visibility level
privacyUrl : link to privacy disclaimer page
webhook : url to endpoint, to which events will be posted - only visible to users with tenant management rights
apiKey : apiKey for authentication with the Roomle API - only visible to users with tenant management rights
packages : list of active packages for this tenant. can contain
tenant_free
,tenant_basic
,tenant_premium
,tenant_enterprise
configurators : tenant configurators
links : contains a sequence of links, where to collect additional data connected with the tenant
allowRegistration: registration allowed or not
branded : branded or not
users : users connected with this tenant
skin : tenant skin
catalogs : list of catalogs owned by this tenant
visibleCatalogs : list of visible catalogs for this tenant
shownCatalogs : list of shown catalogs for this tenant
configuration - tenant configuration
modules : modules tenant can access
catalogConnections: list of connection objects for the existing connections to catalogs. this includes owned catalogs and catalogs of other tenants that this tenant has explicit rights to or wants to show them. Can be updated with the Update call to add visibility to new catalogs.
API Reference
POST /
Accepts: application/json
Generates: json
Creates a new tenant.
Must be super admin.
The new tenant must be given a unique name.
Response: