How to create system Users?
Updated on 30 Mar 2023
The Administrator is responsible for onboarding system Users, and self-registration as a system User is not permitted. This functionality is currently not available on the UI but can be easily added based on the existing implemented flow.
Create a system User using API:
- To call the listed below APIs, an authorisation as Administrator is required.
- The service user should be linked to the system organization which could be “system’’, “support” or “cashdesk”. Please check to which system organizations certain Role belongs.
- Find below an example of how to create a user with the “Accountant” Role.
APIs for this use case:
API name | Endpoint | Request values | Save from response | Comment |
View list of organizations | POST /api/v1/organizations | 1{ 2 “filter”:{ 3 “types”:[ 4 “system” 5 ] 6 }, 7 “sort”: { 8 “creationDate”: “desc” 9 } 10} | id | system type should be provided in the request filter to get only system organizations |
Register a new service user | POST /api/v1/users | 1{ 2 “login”: “string”, 3 “role”: “string”, 4 “organizationId”: “string” 5} | Login: email or phone number, Role: accountant organizationId – id from the previous response. |
Users will be created with a preconfigured list of default permissions.