Get users
Updated on 22 Feb 2021
Description
Use Case allows an External Entity or an Individual to request a list of all Users registered with System Operator. The selection is based on the filtering parameters submitted with the request.
Actors
- External Entity that can interact with System Operator API acting as a registered System Operator user.
- System Operator running “SDK.Finance” software and exposing the portfolio of financial APIs.
Preconditions
- 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.
- Perform all steps of Use Case “Autorization”.
- External Entity sends a request to System Operator with filtering information to get a list of Users.
API endpoint: https://sdkfinance.app/swagger/ui/#!/User_management/Get_users
Parameters:
Authorization
Request body example:
{ "filter":{ "ids":[ "string" ], "email":"string", "emailVerified":false, "phone":"string", "phoneVerified":false, "text":"string", "banned":false, "active":false, "roles":[ "string" ], "organizationIds":[ "string" ] }, "sort":{ "date":"asc", "active":"asc" }, "pageNumber":0, "pageSize":0 } |
- System Operator returns a List of Users to External Entity.
Optional Flow with Web Browser UI
- Perform all steps of Use Case “Authorization”.
- A user sends a request from the Browser to System Operator with filtering information to get a list of Users.
API endpoint: https://sdkfinance.app/swagger/ui/#!/User_management/Get_users
Parameters:
Authorization
Request body example:
{ "filter":{ "ids":[ "string" ], "email":"string", "emailVerified":false, "phone":"string", "phoneVerified":false, "text":"string", "banned":false, "active":false, "roles":[ "string" ], "organizationIds":[ "string" ] }, "sort":{ "date":"asc", "active":"asc" }, "pageNumber":0, "pageSize":0 } |
- System Operator returns a web page with a List of Users.
Post Conditions
External Entity or User can see requested Users.
Result
{ "users":[ { "userId":"string", "name":"string", "createdAt":"2018-06-25T11:17:06.079Z", "active":false, "banned":false, "banExpiryDate":"2018-06-25T11:17:06.079Z", "contact":{ "phoneNumber":"string", "phoneVerified":false, "email":"string", "emailVerified":false, "countryCode":"AD" }, "members":[ { "id":"string", "role":"string", "organization":{ "id":"string", "type":"string", "name":"string" } } ] } ] } |
