Delete user
Description
Authenticated users with the role of USER_MANAGER executes steps of Use case Get users. Sends a request to Endpoint Delete user.
Actors
- External Entity that can interact with System Operator API acting as a registered System Operator user with the roles of USER_MANAGER.
- System Operator running “SDK.Finance” software and exposing the portfolio of financial APIs.
Preconditions
- User must have a System Operator profile.
- There users in the System.
Basic Flow
By default, this flow assumes that External Entity sends Requests to System Operator Endpoints and System Operator sends back Responses to External Entity.
- Perform all steps of Use Case “Get users”.
- External Entity sends a request to Endpoint “Delete a user”.
API endpoint: https://sdkfinance.app/api/ui/#!/User_management/Delete_user
Parameters:
userId
Authorization
- System Operator returns a result confirmation to External Entity. (See Result example below)
Optional Flow with Web Browser UI
- Perform all steps of Use Case “Get users”.
- A user sends a request to Endpoint “Delete a user”.
API endpoint: https://sdkfinance.app/api/ui/#!/User_management/Delete_user
Parameters:
userId
Authorization
- System Operator returns a result confirmation to External Entity. (See Result example below)
Post Conditions
The user is not in the System anymore.
Response example
{ "status":"ok", "message":"string" } |