Delete the Tenant
DELETE/projects/{projectId}/tenants/{homeId}
Base URL: https://api.tinkermode.com
Delete a tenant from a multi-tenant project. This will delete the home (tenant), the tenant root entity, tenant admin access control group, all the users that belong exclusively to the tenant (if any), and all associated permissions.
Prerequisites:
- The project must have multi-tenancy enabled
- There should be no installed BizStack Apps in the tenant
- The home (tenant) must have the 'tenant' field in its metadata
Required Permissions:
- Permission to delete the home.
- Permission to delete the tenant admin access control group.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain a user API key of a user with tenant deletion permissions, a service account token with the same permission, or a project API key with admin permissions.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
homeId | integer | Yes | The unique ID of the home. |
Responses
204 Successful deletion of tenant.
401 Authorization is required to access this resource.
403 Request failed because of invalid data or denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |