As of Version product version 2020 Winter | component version 1.0

Request Method DELETE

Response Format HTTP status code

Required Permission

Available if listed in authorization.accesses in authentication-prod.yml and the specified access condition is matched. In the default configuration, access is granted via the YUUVIS_SYSTEM_INTEGRATOR role.

>> AUTHENTICATION Service

Description

Deletes the specified tenant.

The tenant is only deleted if no DMS objects are stored. If the tenant does not contain any DMS object, all client-side configurations are deleted. The configuration files saved via the CONFIGSERVICE like tenant schema, forms, localization files, and catalogs are deleted as well. In case the CONFIGSERVICE is not available, those configuration files remain and have to be deleted manually later on.

All users of the deleted tenant are deleted as well. If they have active sessions, they are invalidated (as of 2022 Summer).

Note: This endpoint is still under development. Its behavior might change with the next release.

Meaning of the response status codes:

HTTP Status Code	Meaning
`204 NO CONTENT`	Successful, the specified `tenant` has been deleted.
`401 UNAUTHORIZED`	The call was unauthorized.
`404 NOT FOUND`	The specified `tenant` was not found.

Request Example

/tenant-management/api/system/tenants/myTenant

Response Example

204 NO CONTENT

no response body

Browser not supported