Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

As of Versionproduct version 2020 Winter | component version 1.0
Request MethodDELETE
Description


Excerpt
Deletes the specified tenant.

Note: Be careful with this call! This endpoint is still in development. Currently, only the Keycloak Realm is deleted. All settings in the yuuvis® backend stay active. The endpoint will be available with full functionality in May 2021 at the latest.


Beginning with version 2021 Summer Alpha 4, if no object is stored in a tenant all basic configurations are removed from the yuuvis® backend.

Beginning with version 2021 Winter, the artifacts saved in the config service like tenant schema, forms, localization files, and catalogs are removed as well.

Open and planned for 2022 Spring:

  • The objects of the tenant can be removed as well.
  • The user configurations that are saved in the User Service will be deleted as well.  

Meaning of the response status codes:


HTTP Status CodeMeaning
204 NO CONTENTSuccessful, the specified tenant has been deleted.
401 UNAUTHORIZEDThe call was unauthorized.
404 NOT FOUNDThe specified tenant was not found.


Request Example

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

Response Example

204 NO CONTENT

no response body

...