Updated on May 16, 2023

Get User by Username

Use GET method to inquire the existing User by Username (userName). Endpoint: GET  .../api/users/{userName} The userName value indicated in the URL is the target User Username.

Response Parameters

Name Type Description
id integer System user identifier.
operatorId integer Operator identifier.
serviceProviderId integer Service Provider identifier.
Serves as skinid for user authorization purposes.
userName string Username.
MaxLength(20)
Special characters ” and \ must be placed as \” and \\
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 In case returned true user has access to all available Platform Accounts and Sub-Accounts. In case returned false user has only access to the account(s) specified in the response account(s).
accounts object Available Platform Accounts and Sub-Accounts for this user.
isMfaEnabled bool Parameter that indicates using of the Multi-factor Authentication functionality.

Response Codes

Response Code Description
200 Ok
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. 
				
					.../api/users/{userName}
Response

{
  "id": 0,
  "operatorId": 0,
  "serviceProviderId": 0,
  "userName": "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",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "phone": "string",
  "userRole": 0,
  "addAllAccounts": true,
  "accounts": [],
  "isMfaEnabled": true
}