Delete Tenant
This API deletes an existing tenant identified by its unique ID. Once deleted, the tenant and its associated resources can no longer be accessed.
Endpoint Details
| URL | /v1/auth/tenants/id |
| Method | DELETE |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must be application/json |
Request Path
To delete a specific tenant, use the following request format:
/v1/auth/tenants/0c44159c-9fdd-4dce-b03f-c0eb5ee806d7
Path Parameter
| Parameter | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the tenant to delete |
Response
Here is an example response after the request has been successfully processed:
Response
{
"success": true
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| success | Boolean | Indicates whether the tenant was successfully deleted |
info
- A valid Bearer Token is required to access this endpoint.
- The
idpath parameter must reference an existing tenant. - Deleting a tenant is permanent and cannot be undone. All resources associated with the tenant will be removed.