A user is a person associated with a customer account with at least one CMS license.
IAP/REST Operations
Details of these operations are provided in the API Reference under Users.
Getting a List of Users
Returns either all users or a specific user, depending on the parameters that are specified with the call.
GET /iap/users
Response:
[
{
"id": 44,
"userName": "admin",
"firstName": "System",
"lastName": "Administrator",
"emailAddress": "fake_email@localhost.net",
"locale": null,
"customerId": null,
"userType": "ADMIN",
"licenseAgreementAccepted": true,
"demoMode": "GLOBAL",
"googleApiKey": "AIzaSyBPoKM5jk-m4DZk1F_4armlUCXXyHfi6Bo",
"blocked": false
},
{
"id": 486,
"userName": "user",
"firstName": "User",
"lastName": "User",
"emailAddress": "user@user.com",
"locale": null,
"customerId": 81,
"userType": "USER",
"licenseAgreementAccepted": true,
"demoMode": "GLOBAL",
"googleApiKey": "33",
"blocked": false
},
{
"id": 485,
"userName": "owner",
"firstName": "Owner",
"lastName": "Owner",
"emailAddress": "owner@owner.com",
"locale": null,
"customerId": 81,
"userType": "OWNER",
"licenseAgreementAccepted": true,
"demoMode": "GLOBAL",
"googleApiKey": "33",
"blocked": false
}
]
GET /iap/users?id=44
Response:
[
{
"id": 44,
"userName": "admin",
"firstName": "System",
"lastName": "Administrator",
"emailAddress": "fake_email@localhost.net",
"locale": null,
"customerId": null,
"userType": "ADMIN",
"licenseAgreementAccepted": true,
"demoMode": "GLOBAL",
"googleApiKey": "AIzaSyBPoKM5jk-m4DZk1F_4armlUCXXyHfi6Bo",
"blocked": false
}
]
Returns the user associated with the current session.
GET /iap/users/current
Response:
{
"id": 44,
"userName": "admin",
"firstName": "System",
"lastName": "Administrator",
"emailAddress": "fake_email@localhost.net",
"locale": null,
"customerId": null,
"userType": "ADMIN",
"licenseAgreementAccepted": true,
"demoMode": "NO",
"googleApiKey": "AIzaSyBPoKM5jk-m4DZk1F_4armlUCXXyHfi6Bo",
"blocked": false
}
Returns locale of the current user session.
GET /iap/users/locale
Response:
{
"value": "en-us"
}
Returns collections of supported locales.
GET /iap/users/list
Response:
{
"value": "[en-us, es-mx]"
}
Returns the customer information associated with the specified userID.
| GET | /iap/users/{userID}/customer
|
GET /iap/users/81/customer
Response:
{
"id": 81,
"name": "Customer 1",
"shortName": "cst",
"cid": 1,
"encryptionKey": "7ff91b86c75942e44c0055a724c7353c",
"deviceSearchingRange": 50,
"deviceNumberLimitation": 255,
"licensingEnhancement": "PREMIUM",
"googleApiKey": "33",
"licenseTill": 1868874911262
}
Returns the count for the number of users
GET /iap/users/count
Response:
{
"value": 3
}
Adding a User
Adds to the CMS, a new user with the specified properties. Request payload requires a user name and password to be provided.
POST /iap/users
Request payload:
{
"userName":"test_user",
"demoMode":"GLOBAL",
"firstName":"TEST USER",
"lastName":"TEST USER",
"emailAddress":"test_user@user.com",
"userType":"USER",
"customerId":81,
"password":"TEST$12345$"
}
Response:
{
"id": 1393,
"userName": "test_user",
"firstName": "TEST USER",
"lastName": "TEST USER",
"emailAddress": "test_user@user.com",
"locale": null,
"customerId": 81,
"userType": "USER",
"licenseAgreementAccepted": true,
"demoMode": "GLOBAL",
"googleApiKey": "33",
"blocked": false
}
Updating a User
Updates an existing user with the specified properties.
PUT /iap/users
Request payload:
{
"id":1393,
"userName":"test_user",
"firstName":"UPDATED USER",
"lastName":"UPDATED USER",
"emailAddress":"test_user@user.com",
"locale":null,
"customerId":81,
"userType":"USER",
"licenseAgreementAccepted":true,
"demoMode":"GLOBAL",
"googleApiKey":"33",
"blocked":false
}
Response:
{
"id": 1393,
"userName": "test_user",
"firstName": "UPDATED USER",
"lastName": "UPDATED USER",
"emailAddress": "test_user@user.com",
"locale": null,
"customerId": 81,
"userType": "USER",
"licenseAgreementAccepted": true,
"demoMode": "GLOBAL",
"googleApiKey": "33",
"blocked": false
}
Changes a user's password. Required old password and new password of the user.
PUT /iap/users/cp
Request payload:
{
"userName":"admin",
"currentPassword":"admin",
"newPassword":"Qwerty12345$"
}
Response:
empty
Changes locale of the current user session
Request payload:
es-mx
Response:
empty
Accepting a User's License
Accepts the license for the current user. This operation is required only for the following user types: user manager, owner, and admin.
All other types of users don't need to accept the license agreement. User is prohibited to use any other restful API methods before he accepts the license
agreement except for login and logout methods.
| PUT | /iap/user/acceptlicense
|
PUT /iap/user/acceptlicense
Request payload:
empty
Request payload:
Success
Deleting a User
Deletes from the CMS, the user with the specified userID. Required ID of the user to delete.
| DELETE | /iap/users/{userID}
|
DELETE /iap/users/81
Response:
empty