Delete Tenant

Delete Tenant is used to delete a tenant, which was created using Create Tenant.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL for SSMS

DELETE https://{tenantId}.{hostname}/digitanium/v4/tenants/{tenantId}

HTTP request URL for SHIFT

DELETE https://{hostname}/auth/realms/{tenantId}/v3_realm/{tenantId}

note

API requests must be made over https. Calls made over plain http will fail. {tenantId} which is used in http request should be a master tenantId.

Parameters

No parameter fields are required.

Request body

No request body fields are required.

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
    "message": "Tenant deleted successfully",
    "status": "OK",
    "subSystem": 1
}

Response Status Information

Status Code	Status	Message
200	OK	Tenant deleted successfully
401	Unauthorized	HTTP 401 Unauthorized
404	TENANT_NOT_FOUND	Tenant does not exist