The TECS User Management API enables users to:
- Register new users within their organization on TECS Platform
- Assign roles to users within their organization
Register a new user within your organization
curl -X POST \
"https://test.tecs.at/usermanagement-backofficews/registerUser" \
-H "accept: */*" \
-u User1:Password1 \
-H "Content-Type: application/json" \
-d "{ \"city\": \"Berlin\",
\"country\": \"Germany\",
\"dateOfBirth\": \"01.01.2000\",
\"driverLicenceNumber\": \"DC357158\",
\"email\": \"[email protected]\",
\"firstName\": \"UserName\",
\"identificationNumber\": \"19574328625\",
\"lastName\": \"UserSurname\",
\"login\": \"userlogin\",
\"passportNumber\": \"VH488314\",
\"phone\": \"+4991199009926\",
\"salutation\": \"Mr.\",
\"state\": \"Berlin\",
\"street1\": \"Potsdamer\",
\"street2\": \"13\",
\"zip\": \"10783\"}"
Parameter | Type | Required | Description |
---|
city | string | optional | User city |
country | string | optional | User country |
dateOfBirth | string | optional | User date of birth |
driverLicenceNumber | string | optional | User driver license number |
email | string | required | User email |
firstName | string | optional | User first name |
identificationNumber | string | optional | User ID number |
lastName | string | optional | User last name |
login | string | optional | User login |
passportNumber | string | optional | User passport number |
phone | string | optional | User phone number |
salutation | string | optional | User salutation |
state | string | optional | User state |
street1 | string | optional | User address (first line) |
street2 | string | optional | User address (second line) |
zip | string | optional | User postal code |
{
"responseCode":0,
"responseMessage":"OK",
"consumerId":"userlogin"
}
Parameter | Type | Description |
---|
responseCode | int | Response code (0 = OK, otherwise an error code) |
responseMessage | string | Human readable response code representation |
consumerId | string | User login or unique ID |
Error Code | Error Message |
---|
24000 | You don't have permissions (state User_HasNotRole) |
24001 | You don't have permissions (state Mandator_IsNotTheSame) |
24012 | Mandatory fields are not filled %1$s (state MandatoryFields_AreNotFilled) |
24014 | with arbitrary message (state Unexpected_Exception) |
24029 | terminalid (must be present, in correct format) |
24030 | reason_deactivation (must be present, in correct format) |
25000 | INTERNAL_SERVER_ERROR |
25001 | OAUTH_INTERACTION_FAILED |
25002 | OAUTH_INVALID_TOKEN |
25003 | UNAUTHORIZED |
25004 | BAD_REQUEST |
25005 | USER_INACTIVE |
25007 | TECS_TERM_NOT_FOUND |
25008 | MANDATOR_NOT_FOUND |
25012 | DATA_INTEGRITY_ERROR |
25013 | DATA_ACCESS_ERROR |
Assign roles to an existing user.
curl -X POST "https://dev.tecs.at/usermanagement-backofficews/assignRoles" \
-H "accept: */*" \
-u User1:Password1 \
-H "Content-Type: application/json" \
-d "{ \"consumerUUID\": \"userlogin\",
\"roles\": [ { \"corporateUUID\": \"4dbbab90-74f5-4d8d-92e1-d02e6a4a0dee\", \"userRoleName\": \"MP_CORPORATE\" } ]}"
Parameter | Type | Mandatory | Description |
---|
consumerUUID | string | mandatory | User login |
corporateUUID | string | optional | Unique ID of the corporate |
userRoleName | string | optional | Name of the role |
{
"responseCode":0,
"responseMessage":"OK"
}
Parameter | Type | Description |
---|
responseCode | int | Response code (0 = OK, otherwise an error code) |
responseMessage | string | Human readable response code representation |
Error Code | Error Message |
---|
24000 | You don't have permissions (state User_HasNotRole) |
24001 | You don't have permissions (state Mandator_IsNotTheSame) |
24012 | Mandatory fields are not filled %1$s (state MandatoryFields_AreNotFilled) |
24014 | with arbitrary message (state Unexpected_Exception) |
24029 | terminalid (must be present, in correct format) |
24030 | reason_deactivation (must be present, in correct format) |
25000 | INTERNAL_SERVER_ERROR |
25001 | OAUTH_INTERACTION_FAILED |
25002 | OAUTH_INVALID_TOKEN |
25003 | UNAUTHORIZED |
25004 | BAD_REQUEST |
25005 | USER_INACTIVE |
25007 | TECS_TERM_NOT_FOUND |
25008 | MANDATOR_NOT_FOUND |
25012 | DATA_INTEGRITY_ERROR |
25013 | DATA_ACCESS_ERROR |