DELETE /tenant-management/api/admin/users/{id}

Owned by Team Kolibri (Unlicensed)
Last updated: Jul 14, 2022 by Technische Redaktion
1 min read
As of Versionproduct version 2020 Winter | component version 1.0
Request MethodDELETE
Response FormatHTTP 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_TENANT_ADMIN and YUUVIS_MANAGE_SETTINGS (as of 2022 Autumn) roles.

>> AUTHENTICATION Service
Description

Deletes the user specified by id.

As of 2022 Summer, all active sessions of the deleted user are invalidated.

As of version 2022 Autumn, in the default access authorization configuration, users with the YUUVIS_MANAGE_SETTINGS roles are allowed to use the endpoint as well. However, they are not allowed to delete users with the YUUVIS_TENANT_ADMIN or YUUVIS_SYSTEM_INTEGRATOR role assigned.

Meaning of the response status codes:
HTTP Status CodeMeaning
204 NO CONTENTSuccessful, the specified user has been deleted
401 UNAUTHORIZEDThe call was unauthorized.
404 NOT FOUNDThe specified user was not found.
Request Example

/tenant-management/api/admin/users/a99a0bb1-2345-6c77-8901-22dee3f4a567

Response Example

204 NO CONTENT

no response body