User Controller

Introduction

The User controller provides user management capabilities within AdmiralCloud's IAM system. It covers the full lifecycle of a user account: creating and inviting users, updating profile information, managing user-to-app relations, and deleting or anonymizing users when they leave your organization.

Users in AdmiralCloud are always scoped to a customer account. A user can be bound to one or more apps (identified by clientId) and inherits permissions through the IAM permission system. Customer administrators have full control over the users within their account; users without a customer binding (e.g. self-registered users) can only manage their own account.

Delete an existing user

Depending on several factors, the user will be marked as deleted, anonymized or finally deleted.

Generally, if you send a clientId with the delete request, only the relation between user and app (clientId) will be removed.

Bound to customer account

If a user is bound to a customer account (released is not set or 0), the customer account has all permissions to mange the user. If the user to be destroyed has contributed data to AdmiralCloud it will never be deleted but only anonymized (default setting) or just marked as deleted. Otherwise the user will be finally deleted. The same is true for user-app-relations: They will be marked as deleted (flag 99) if the user has contributed data to this app, otherwise the relation will be deleted from our database.

User without a customer account

If a user has no customer account or has been released destroying the user only has an affect on apps related to the customer account trying to destroy it. The user itself will never be changed or deleted. This kind of user can only delete themselves.

Anonymizing

If a user has contributed data, it is no longer possible to delete that user from the database. Instead, the default setting is to anonymize that user. The user will get a random name and firstname, as well as a random e-mail-address from domain "deactivatedusers.admiralcloud.com". All settings of the user that can identify the user will be removed from the user model (e.g. individual configuration, location info).

ClientId is set

• only the relation between clientId and userId is deleted (no contribution) or marked deleted (user has made contribution)
• the user data is left intact

User belongs to customer

• relations between userId and all clientIds/apps are either deleted (no contribution) or marked deleted (contribution)
• user is anonymized (default) if the user has contributed to any application, if not the user will be completely deleted

User has no customerId

• user has usually registered himself
• user can also be released from a customer account by a customer admin
• only relations between userId and all clientIds/apps are either deleted (no contribution) or marked deleted (contribution)
• user data is left intact