Delete a User
DELETE /obp/v7.0.0/users/USER_ID
OBPv4.0.0-deleteUser Roles: CanDeleteUser User
Delete a User.
This is a soft delete: the database row is kept, but the User's personal data is scrambled i.e. overwritten with random values:
- The username is replaced with DELETED-<random-string>
- The first name, last name and email are replaced with random values
- The password is replaced with a random value and the user is invalidated, so the User can no longer log in
- Any User Invitation that created the User is scrambled in the same way
The User is marked as deleted; any subsequent authentication as this User (including via existing tokens or consents) is rejected.
The USER_ID is retained, so records that reference it (e.g. metrics and transaction history) keep their audit value but can no longer be linked to a person.
This action cannot be undone.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
USER_ID: 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields (0)
Possible errors (4)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.