Clean the ban for user

Updated on 30 Apr 2020

Description

Authenticated users with roles of Admin and CFO execute steps of Use case Get users. Find a user whose status is “Banned”. Send a request to Endpoint “Clean the ban for user”.

Actors

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

Preconditions

  1. The user must have a System Operator profile.
  2. There are Banned 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 “Clean the ban for user”.

API endpoint: https://sdkfinance.app/api/ui/#!/User_management/unBan

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 “Clean the ban for user”.

API endpoint: https://sdkfinance.app/api/ui/#!/User_management/unBan

Parameters: 

userId

Authorization

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

Post Conditions

Earlier banned user is now active.

Result example



   "user":{ 

      "id":"string",

      "name":"string",

      "createdAt":"2018-07-25T12:12:34.347Z",

      "active":false,

      "banned":false,

      "banExpiryDate":"2018-07-25T12:12:34.347Z",

      "contact":{ 

         "phoneNumber":"string",

         "phoneVerified":false,

         "email":"string",

         "emailVerified":false,

         "countryCode":"AD"

      },

      "members":[ 

         { 

            "id":"string",

            "role":"string",

            "organization":{ 

               "id":"string",

               "type":"string",

               "name":"string"

            }

         }

      ]

   },

   "status":"ok",

   "message":"string"

}