DELETE /config/access/tenant_management/tenants/{tenant_id}

Delete a tenant.

Deletes a tenant by tenant id.

Table 1. DELETE /config/access/tenant_management/tenants/{tenant_id} resource details
MIME Type
application/json

Table 2. DELETE /config/access/tenant_management/tenants/{tenant_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
tenant_id	path	Required	Number (Integer)	text/plain	Required - String - id associated to a tenant

Table 3. DELETE /config/access/tenant_management/tenants/{tenant_id} response codes
HTTP Response Code	Unique Code	Description
200		The tenant was deleted successfully (soft delete).
404	1002	The tenant does not exists.
422	1003	The tenant cannot be deleted while there are domains assigned to it.
500	1020	An error occurred while deleting tenant.

Response Description

the deleted tenant object with its parameter deleted set to true


{
    "deleted": true,
    "description": "String",
    "event_rate_limit": 42,
    "flow_rate_limit": 42,
    "id": 42,
    "name": "String"
}