Home › API › Delete user

Delete user

Updated on 22 Feb 2021

Description

Authenticated users with the role of USER_MANAGER executes steps of Use case Get users. Sends a request to Endpoint Delete user.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator user with the roles of USER_MANAGER.
  2. System Operator running “SDK.Finance” software and exposing the portfolio of financial APIs.

Preconditions

  1. User must have a System Operator profile.
  2. 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.

  1. Perform all steps of Use Case “Get users”.
  2. External Entity sends a request to Endpoint “Delete a user”.

API endpoint: https://sdkfinance.app/swagger/ui/#!/User_management/Delete_user

Parameters: 

userId

Authorization

  1. System Operator returns a result confirmation to External Entity. (See Result example below)

Optional Flow with Web Browser UI

  1. Perform all steps of Use Case “Get users”.
  2. A user sends a request to Endpoint “Delete a user”.

API endpoint: https://sdkfinance.app/swagger/ui/#!/User_management/Delete_user

Parameters: 

userId

Authorization

  1. 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"

}