Validate secret word

Updated on 30 Apr 2020

Description

The user or External entity acting as a User with Role Permissions: USER_VIEWER, USER_MANAGER, PROFILE_MANAGER can access the list of System Users, pick up a particular User and send the request to validate a secret word.

Actors

  1. External Entity that can interact with System Operator API acting as a registered System Operator User with the following Role Permissions: USER_VIEWER, USER_MANAGER, PROFILE_MANAGER.
  2. System Operator running “SDK.Finance” software and exposing the portfolio of financial APIs.

Preconditions

  1. The user must have a System Operator profile.

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 “Validate secret word”.

API endpoint: https://sdkfinance.app/api/ui/#!/Operator_profile_management/validateSecretWord

Parameters:

userId

Authorization

Request body example:



   "secretWord":"string"

}
  1. System Operator validates a secret word and returns result information 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 “Validate secret word”.

API endpoint: https://sdkfinance.app/api/ui/#!/Operator_profile_management/validateSecretWord

Parameters:

userId

Authorization

Request body example:



   "secretWord":"string"

}
  1. System Operator validates a secret word and returns result information to External Entity. (See Result example below)

Post Conditions

If the secret word is valid the result is “ok”.

Response example



   "status":"ok",

   "message":"string"

}