Tenant

#TenantController

Overview

• Description

  • Tenant object example

  • Fields

• POST /

• GET /:id

• PUT /:id

• DELETE /:id

• POST /:id/promocode

• Links

  • Tenant users

    • GET /:id/users

    • POST /:id/users

    • PUT /:id/users/userId

  • Payment Connections

    • GET /:id/paymentConnections

    • POST /:id/paymentConnections

    • POST /:id/paymentConnectionsSessions

  • Billing Information

    • GET /:id/billingInformation

    • POST /:id/billingInformation

    • PUT /:id/billingInformation

  • Usages

    • GET /:id/usages

  • AssetProcessings

    • GET /:id/assetProcessings

  • Other

    • GET /:id/roles

    • GET /:id/catalogs

    • GET /:id/visibleCatalogs

    • GET /:id/shownCatalogs

    • GET /:id/enableTags

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.

{
  "id": 0,
  "name": "myName",
  "label": "myLabel",
  "active": true,
  "showLanguageSwitch": true,
  "authenticationRequired": true,
  "visibility": 10,
  "privacyUrl": "https://www.myDomain.com/privacy.html",
  "webhook": "https://api.myDomain.com/webhookEndpoint",
  "apiKey": "aValidApiKey",
  "packages": [
    {
      "id": "internalId",
      "package": "tenant_free",
      "fromPromocode": false,
      "validFrom": "2000-01-01T00:00:00.000Z",
      "validTill": "2100-01-01T00:00:00.000Z"
    }
  ],
  "links": {
    "plans": "/tenants/0/plans",
    "roles": "/tenants/0/roles/",
    "users": "/tenants/0/users/",
    "catalogs": "/tenants/0/catalogs/",
    "retailerInfos": "/tenants/0/retailerInfos/",
    "visibleCatalogs": "/tenants/0/visibleCatalogs/",
    "shownCatalogs": "/tenants/0/shownCatalogs/",
    "paymentConnections": "/tenants/0/paymentConnections/",
    "billingInformation": "/tenants/0/billingInformation/",
    "usages": "/tenants/0/usages/"
  },
  "allowRegistration": true,
  "branded": true,
  "catalogConnections": [ 
    {
      "id":"aCatalogId",
      "active":true,
      "owner":true,
      "public":false,
      "visibilityLevel":5
    }
  ],
  "modules": [
    "basic_usage",
    "catalog_management"
  ]
}

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: