Delete Tenants

{ deleteTenants }

Removes tenants from the system.

Method

/API2/access/deleteTenants
  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Can be used by Enterprise Admin users only
  • REST API only via POST actions.
  • Input Parameters

    Name

    deleteTenantApiData

    Object Type

    Description

    The listing of tenants that will be removed from the system.

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    Generic API response object with success or failure flag and related messages.

    Notes

    Use the parameter object to flag if related users and data servers should be removed too. This function cannot be undone. Use it carefully.

    Examples