Alpha Tenants
Tenants API
Find all
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants"[
{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Create a new tenant
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/tenants" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update an existing tenant
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/tenants" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete by list of ids
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants" \ -H "Content-Type: application/json" \ -d '[ "string" ]'Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find by list of ids
AuthorizationBearer <token>
In: header
Query Parameters
ids*array<>
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/find?ids=string"[
{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find by id
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/find/string"{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Verify if tenant name is unique
AuthorizationBearer <token>
In: header
Path Parameters
tenantName*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/is-unique/string"true{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Upload a light theme logo for a tenant
AuthorizationBearer <token>
In: header
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/tenants/light-theme-logo" \ -F file="string"{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Remove light theme logo for a tenant
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/light-theme-logo"{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Upload a logo for a tenant
AuthorizationBearer <token>
In: header
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/tenants/logo" \ -F file="string"{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Remove logo for a tenant
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/logo"{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get current tenant
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/me"{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get page by page number and size with optional sorting based on field to sortBy and direction
AuthorizationBearer <token>
In: header
Query Parameters
pageNumber?integer
Format
int32pageSize?integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"search?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/page"{
"content": [
{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get tenant branding by custom domain
AuthorizationBearer <token>
In: header
Query Parameters
domain*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/public/branding/by-domain?domain=string"{
"accentColor": "string",
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
{
"code": "string",
"feeFixed": 0.1,
"feePercent": 0.1,
"label": "string"
}
],
"freeShippingThreshold": 0.1,
"logoId": "string",
"name": "string",
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"shopEnabled": true,
"tenantId": "string",
"termsAndConditions": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get tenant branding by code
AuthorizationBearer <token>
In: header
Path Parameters
code*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/public/branding/string"{
"accentColor": "string",
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
{
"code": "string",
"feeFixed": 0.1,
"feePercent": 0.1,
"label": "string"
}
],
"freeShippingThreshold": 0.1,
"logoId": "string",
"name": "string",
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"shopEnabled": true,
"tenantId": "string",
"termsAndConditions": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Upload a shop banner image
AuthorizationBearer <token>
In: header
Request Body
multipart/form-data
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/tenants/shop/banner" \ -F file="string"{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Remove shop banner image
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/shop/banner"{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get tenant summaries with user counts
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/summaries"[
{
"tenant": {
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"userCount": 0
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update an existing tenant by ID
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/tenants/string" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete by id
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string"Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Set tenant active status
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Query Parameters
active*boolean
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/tenants/string/active?active=true"{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update an existing tenant scopes
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/tenants/string/scopes" \ -H "Content-Type: application/json" \ -d '{ "assetManagement": true, "calendar": true, "clients": true, "communications": true, "concepts": true, "configurator": true, "crm": true, "environment": true, "finance": true, "hr": true, "inventory": true, "production": true, "products": true, "projects": true, "reporting": true, "subsidiaries": true, "suppliers": true, "support": true, "tasks": true }'{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Clear all incoming stock transfers for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/data/incoming-stock-transfers"{
"deletedCount": 0,
"entityType": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Clear all inventory data for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/data/inventory"{
"deletedCount": 0,
"entityType": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Clear all picklists for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/data/picklists"{
"deletedCount": 0,
"entityType": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Clear all product data for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/data/products"{
"deletedCount": 0,
"entityType": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Clear all purchase orders for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/data/purchase-orders"{
"deletedCount": 0,
"entityType": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Clear all sales orders for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/data/sales-orders"{
"deletedCount": 0,
"entityType": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Clear all shifts for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/data/shifts"{
"deletedCount": 0,
"entityType": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get tenant data stats
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/string/data/stats"{
"incomingStockTransferCount": 0,
"inventoryCount": 0,
"picklistCount": 0,
"productCount": 0,
"purchaseOrderCount": 0,
"salesOrderCount": 0,
"shiftCount": 0,
"stockCountCount": 0,
"stockTransferCount": 0,
"wasteCount": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Clear all stock counts for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/data/stock-counts"{
"deletedCount": 0,
"entityType": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Clear all stock transfers for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/data/stock-transfers"{
"deletedCount": 0,
"entityType": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Clear all waste for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/data/waste"{
"deletedCount": 0,
"entityType": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get all members of a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/string/members"[
{
"email": "string",
"firstName": "string",
"hasFullAccess": true,
"id": "string",
"language": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastName": "string",
"profile": {
"avatar": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"displayName": "string",
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
}
},
"projectAccess": [
"string"
],
"roles": [
"string"
],
"status": "ACTIVE",
"subsidiaryAccess": [
"string"
],
"tenantId": "string",
"verified": true
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Invite user to tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/tenants/string/members/invite" \ -H "Content-Type: application/json" \ -d '{ "email": "string", "sendEmail": true, "verificationBaseUrl": "string" }'{
"email": "string",
"firstName": "string",
"hasFullAccess": true,
"id": "string",
"language": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastName": "string",
"profile": {
"avatar": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"displayName": "string",
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
}
},
"projectAccess": [
"string"
],
"roles": [
"string"
],
"status": "ACTIVE",
"subsidiaryAccess": [
"string"
],
"tenantId": "string",
"verified": true
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Resend invitation email
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/tenants/string/members/resend-invite" \ -H "Content-Type: application/json" \ -d '{ "email": "string", "verificationBaseUrl": "string" }'Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Remove user from tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
email*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/members/string"{
"email": "string",
"firstName": "string",
"hasFullAccess": true,
"id": "string",
"language": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastName": "string",
"profile": {
"avatar": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"displayName": "string",
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
}
},
"projectAccess": [
"string"
],
"roles": [
"string"
],
"status": "ACTIVE",
"subsidiaryAccess": [
"string"
],
"tenantId": "string",
"verified": true
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Override user password
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
email*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/tenants/string/members/string/override-password" \ -H "Content-Type: application/json" \ -d '{ "newPassword": "stringst" }'{
"email": "string",
"firstName": "string",
"hasFullAccess": true,
"id": "string",
"language": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastName": "string",
"profile": {
"avatar": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"displayName": "string",
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
}
},
"projectAccess": [
"string"
],
"roles": [
"string"
],
"status": "ACTIVE",
"subsidiaryAccess": [
"string"
],
"tenantId": "string",
"verified": true
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Send password reset email
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
email*string
Query Parameters
verificationBaseUrl*string
Response Body
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/tenants/string/members/string/reset-password?verificationBaseUrl=string"Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update member roles
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
email*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://localhost:18080/api/v1/tenants/string/members/string/roles" \ -H "Content-Type: application/json" \ -d '{ "roles": [ "string" ] }'{
"email": "string",
"firstName": "string",
"hasFullAccess": true,
"id": "string",
"language": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastName": "string",
"profile": {
"avatar": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"displayName": "string",
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
}
},
"projectAccess": [
"string"
],
"roles": [
"string"
],
"status": "ACTIVE",
"subsidiaryAccess": [
"string"
],
"tenantId": "string",
"verified": true
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get all tenant memberships for a user
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
email*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/string/members/string/tenants"[
{
"domain": "string",
"logoBlobId": "string",
"roles": [
"string"
],
"tenantId": "string",
"tenantName": "string",
"userStatus": "ACTIVE"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get all roles for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/string/roles"[
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Create a role for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/tenants/string/roles" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "permissions": { "appPermissions": [ "CREATE_APIKEYS" ], "assetManagementPermissions": [ "CREATE_ASSETS" ], "calendarPermissions": [ "CREATE_CALENDAR_EVENTS" ], "communicationsPermissions": [ "CREATE_TEMPLATES" ], "configuratorPermissions": [ "CREATE_CONCEPTS" ], "crmPermissions": [ "CREATE_LEADS" ], "financePermissions": [ "CREATE_CLIENTS" ], "hrPermissions": [ "CREATE_EMPLOYEES" ], "inventoryPermissions": [ "CREATE_INVENTORY" ], "productionPermissions": [ "CREATE_PRODUCTION" ], "productsPermissions": [ "CREATE_PRODUCTS" ], "projectsPermissions": [ "CREATE_PROJECTS" ], "reportingPermissions": [ "READ_SALES_REPORTS" ] } }'{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update a role for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/tenants/string/roles" \ -H "Content-Type: application/json" \ -d '{ "name": "string", "permissions": { "appPermissions": [ "CREATE_APIKEYS" ], "assetManagementPermissions": [ "CREATE_ASSETS" ], "calendarPermissions": [ "CREATE_CALENDAR_EVENTS" ], "communicationsPermissions": [ "CREATE_TEMPLATES" ], "configuratorPermissions": [ "CREATE_CONCEPTS" ], "crmPermissions": [ "CREATE_LEADS" ], "financePermissions": [ "CREATE_CLIENTS" ], "hrPermissions": [ "CREATE_EMPLOYEES" ], "inventoryPermissions": [ "CREATE_INVENTORY" ], "productionPermissions": [ "CREATE_PRODUCTION" ], "productsPermissions": [ "CREATE_PRODUCTS" ], "projectsPermissions": [ "CREATE_PROJECTS" ], "reportingPermissions": [ "READ_SALES_REPORTS" ] } }'{
"active": true,
"billingInfo": {
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"bank": "string",
"bic": "string",
"cocNumber": "string",
"contacts": [
{
"department": "string",
"email": "string",
"firstName": "string",
"id": "string",
"lastName": "string",
"phone": "string"
}
],
"email": "string",
"iban": "string",
"phone": "string",
"type": "COMPANY",
"vatNumber": "string"
},
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"domain": "string",
"id": "string",
"lightThemeLogo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"logoUrl": "string",
"name": "string",
"owner": "string",
"packageNameFromDomain": "string",
"scopes": {
"assetManagement": true,
"calendar": true,
"clients": true,
"communications": true,
"concepts": true,
"configurator": true,
"crm": true,
"environment": true,
"finance": true,
"hr": true,
"inventory": true,
"production": true,
"products": true,
"projects": true,
"reporting": true,
"subsidiaries": true,
"suppliers": true,
"support": true,
"tasks": true
},
"settings": {
"accentColor": "string",
"code": "string",
"defaultCountry": "string",
"defaultCurrency": "string",
"defaultLanguage": "string",
"defaultProductVisibility": "string",
"defaultTimezone": "string",
"defaultVat": 0.1,
"exchangeRateSyncEnabled": true,
"shopEnabled": true,
"shopSettings": {
"bannerImageId": "string",
"bannerSubtitle": "string",
"bannerTitle": "string",
"enabledPaymentMethods": [
"INVOICE"
],
"freeShippingThreshold": 0.1,
"returnPolicy": "string",
"shippingFlatRate": 0.1,
"shopDescription": "string",
"termsAndConditions": "string"
}
},
"subscription": "TRIAL",
"subscriptionExpires": "2019-08-24T14:15:22Z",
"tenantRoles": [
{
"description": "string",
"name": "string",
"permissions": {
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get valid permissions for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/tenants/string/roles/valid-permissions"{
"appPermissions": [
"CREATE_APIKEYS"
],
"assetManagementPermissions": [
"CREATE_ASSETS"
],
"calendarPermissions": [
"CREATE_CALENDAR_EVENTS"
],
"communicationsPermissions": [
"CREATE_TEMPLATES"
],
"configuratorPermissions": [
"CREATE_CONCEPTS"
],
"crmPermissions": [
"CREATE_LEADS"
],
"financePermissions": [
"CREATE_CLIENTS"
],
"hrPermissions": [
"CREATE_EMPLOYEES"
],
"inventoryPermissions": [
"CREATE_INVENTORY"
],
"productionPermissions": [
"CREATE_PRODUCTION"
],
"productsPermissions": [
"CREATE_PRODUCTS"
],
"projectsPermissions": [
"CREATE_PROJECTS"
],
"reportingPermissions": [
"READ_SALES_REPORTS"
]
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete a role for a tenant
AuthorizationBearer <token>
In: header
Path Parameters
tenantId*string
roleName*string
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/tenants/string/roles/string"Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}