Updated on May 17, 2023

Create User

Use POST method to create a new User. To create a new User, inquire a source User data packet via GET method and pass it with the POST method. Change parameters’ values you wish to override. Endpoint: POST .../api/users

Request Parameters

NOTE: Optional fields can be manually removed from the request in case you want to skip them. Enter valid parameters values in case you want to pass them in the request.
Name Type Required Description
id integer optional System user identifier.
operatorId integer optional Operator identifier. Required for Operator Manager/API Operator Manager
serviceProviderId integer optional Service Provider identifier. Serves as SkinID for user authorization purposes. Required for all Back-Office Users/ API Users
userName string ✓ Username. MaxLength(20) Special characters ” and \ must be placed as \” and \\
password string optional Nullable MaxLength=20 Pass this parameter value to create a temporary password for a system user.
firstName string ✓ User first name. MaxLength(100) Special characters ” and \ must be placed as \” and \\
lastName string ✓ User last name. MaxLength(100) Special characters ” and \ must be placed as \” and \\
email string ✓ User contact email address. MaxLength(50)
phone string ✓ User contact phone number. MaxLength(50)
userRole integer User role.
Available Values:
OperatorManager 2 Back-Office user role. User role for Operators’ users.
ServiceProviderAdmin 3 Back-Office user role. User role for Service Provider Admin users.
PlatformAdmin 4 Back-Office user role. User role for Platform Admin users.
PlatformUser 5 Back-Office user role. User role for Platform users.
ApiProcessingReports 6 API user role. Standard API user.
ApiServiceProviderManagement 7 API user role. Service Provider Admin user access rights.
ApiPlatformManagement 8 API user role. Platform Admin user access rights.
ApiOperatorManager 13 API user role. Operator user access rights.
CustomUserRole id Please contact your admin to get custom user roles ids.
addAllAccounts bool Set true to grand your user permissions to all available Platform Accounts. Set false and list Platform Accounts and Sub-Accounts you wish your user to get access to.
accounts object Available Platform Accounts and Sub-Accounts for this user.
isMfaEnabled bool optional Parameter that indicates using of the Multi-factor Authentication functionality.
Response Parameters
Name Type Description
id integer System user identifier.
Response Codes
Response Code Description
200 Ok
201 Created — User has been created successfully.
400 Bad Request — Your request is invalid.
401 Unauthorized — Authorization failed.
403 Forbidden — Access denied.
404 Not Found — Wrong URL.
415 Unsupported Media Type — Wrong request format.
500 Internal Server Error — We had a problem with our server. Try again later.
503 Service Unavailable — We’re temporarily offline for maintenance. Please try again later. 
				
					

{
  "id": 0,
  "operatorId": 0,
  "serviceProviderId": 0,
  "userName": "string",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "userRole": 0,
  "addAllAccounts": false,
  "accounts": [
    {
      "accountId": 0,
      "subAccounts": [
        0
      ]
    }
  ],
  "isMfaEnabled": true
},

{
  "id": 0,
  "operatorId": 0,
  "serviceProviderId": 0,
  "userName": "string",
  "password": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "userRole": 0,
  "addAllAccounts": true,
  "accounts": [],
  "isMfaEnabled": true
}
Response

{
  "id": 123
}