Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

ON THIS PAGE

Response Description
Response Sample

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

SUMMARY Delete a tenant.

Deletes a tenant by tenant ID. You must have the System Administrator or Security Administrator permissions to call this endpoint.

Table 1: DELETE /config/access/tenant_management/tenants/{tenant_id} resource details:
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:
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 - The ID of the tenant that is being deleted.

Table 3: DELETE /config/access/tenant_management/tenants/{tenant_id} response codes:
DELETE /config/access/tenant_management/tenants/{tenant_id} response codes
HTTP Response Code	Unique Code	Description
200		The tenant was successfully deleted.
404	1002	The tenant does not exist.
422	1003	The tenant cannot be deleted while there are domains assigned to it.
422	1010	The tenant cannot be deleted because it is assigned to deployed actors.
422	1011	The tenant cannot be deleted because it is assigned to staged actors.
500	1020	An error occurred while deleting tenant.

Response Description

The deleted tenant object with its parameter deleted set to true

id - Integer - The ID of the tenant.
name - String - The name of the tenant.
description - String - The description of the tenant.
event_rate_limit - Integer - The event rate limit that is assigned to the tenant.
flow_rate_limit - Integer - The flow rate limit that is assigned to the tenant.
deleted - Boolean - Whether or not the tenant has been deleted. Will be true if the tenant has been deleted, and false if it is still active.

Response Sample