AlphaAlpha Docs
API Reference

Tenant Roles

API calls for managing custom tenant roles.

Create a new tenant role

POST
/roles/tenant

Authorization

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/roles/tenant" \  -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 an existing tenant role

PUT
/roles/tenant

Authorization

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 PUT "http://localhost:18080/api/v1/roles/tenant" \  -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"
}

Assign super admin role to user

POST
/roles/tenant/assign-super-admin/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/roles/tenant/assign-super-admin/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"
}

Assign tenant role to user

PATCH
/roles/tenant/assign/{roleName}/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

roleName*string
email*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/roles/tenant/assign/string/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"
}

Remove super admin role from user

POST
/roles/tenant/remove-super-admin/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

email*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/roles/tenant/remove-super-admin/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"
}

Remove tenant role from user

PATCH
/roles/tenant/remove/{roleName}/{email}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

roleName*string
email*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/roles/tenant/remove/string/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 roles sorted

GET
/roles/tenant/sorted

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/roles/tenant/sorted"
[
  {
    "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"
}

Get all users with the given role

GET
/roles/tenant/users/{roleName}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

roleName*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/roles/tenant/users/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 valid permissions for tenant

GET
/roles/tenant/valid-permissions

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/roles/tenant/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 an existing tenant role

DELETE
/roles/tenant/{roleName}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

roleName*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/roles/tenant/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"
}

Tax Percentages

Previous Page

Tenants

Next Page