Smd service
Smd service provides a definition for a variety of available services, and documents what parameters are expected, how to call the services, and what to expect in return.
Methods:
get(roles, description) Provides an open definition of available web services
roles | array | Array of user roles to extract SMD for |
description | boolean, default: false | If set to true, additional documentation will be appended |
returns | object | JSON formatted description of available web services |
Auth service
Auth service provides methods to perform authentication related actions like signup, signin, get public organization information, reset password, etc
Methods:
forgotPassword(email) Performs a reset of user password by sending reset token to user’s email
string, required | Email address | |
returns | boolean | True in case of success, JSON formatted exception otherwise |
getAuthToken() Creates a short-lived (60s) one-time auth token that can be passed freely on to a third-party for SSO ability.
returns | string | Auth token |
getOrganizationAuthInfo(code, deviceId, clientUIVersion) Provides a public information about specified organization
code | string, required | Organization code |
deviceId | string | Device Id |
clientUIVersion | integer, default: -1 | Current version of UI Params on client |
returns | object | JSON formatted list of organization params, such as: AuthType, Code, Name, Saml, UIParameters |
getResetPasswordInfo(token) Provides a reset password information for specified reset token
token | string, required | Reset token |
returns | object | Email address for specified reset token; JSON formatted array of users with foresaid email |
resendValidateEmail(token, email) Resends user validation email either by specifying Email Validation Token or Email Address
token | string | Email Validation Token |
string | Email Address | |
returns | boolean | True in case of success, JSON formatted exception otherwise |
resetPassword(token, password, orgs) Performs passwort reset (for specific orgs if certain param is presented)
token | string, required | Reset token |
password | string, required | New password |
orgs | array | Array of organization ids |
returns | boolean | True in case of success, JSON formatted exception otherwise |
signin(email, password, organizationCode, deviceId) Performs login into the system
string, required | User Email | |
password | string, required | User Password |
organizationCode | string, required | Organization code |
deviceId | string | Device Id. If this param is empty, administrator login will be performed |
returns | object | JSON formatted object which contains AccessToken, Session expiration time, organization and user objects in case of success, JSON formatted exception otherwise |
signout(allSessions) Performs singout of the system
allSessions | boolean, default: false | If set to true, all the user sessions will be expired |
returns | boolean | True in case of success, JSON formatted exception otherwise |
signup(email, password, firstName, lastName, confirmTOS) First step of admin sign up; Sends the Email Validation Token to specified Email address
string, required | ||
password | string, required | Password |
firstName | string, required | First Name |
lastName | string, required | Last Name |
confirmTOS | boolean, required | Set it to true to confirm accepting Sencha Space’s Terms of Service |
returns | boolean | True in case of success, JSON formatted exception otherwise |
signup2(token) Second step of admin Sign Up; Performs validation of specified token
token | string, required | Token |
returns | object | User email if success, JSON formatted exception otherwise |
signup3(token, organizationCode, country, marketoCookie, region) Third step of admin Sign Up; Allows to specify organization code admin wants to use
token | string, required | Email Validation Token |
organizationCode | string, required | Organization Code |
country | string, required | Country |
marketoCookie | string | Marketo cookie value |
region | string | State/Province |
returns | object | JSON formatted object which contains AccessToken, Session expiration time, organization and user objects in case of success, JSON formatted exception otherwise |
validateEmail(token) Performs validation of user’s Email address
token | string, required | Token |
returns | boolean | True if success, JSON formatted exception otherwise |
User service
User service provides a functional to manage users within your Sencha Web Application Manager Organization
Methods:
delete(id) Deletes specific User
id | integer, required | User Id |
returns | boolean | True in case of success, JSON formatted exception otherwise |
deleteAll(except) Performs deletion of all org Users (except specified)
except | array | Specify an array of User Ids you want to keep in your org |
returns | array | An array of User Ids which have left in organization |
fetch(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of Users
filter | string | Filter to apply to User LastName, FirstName or Email |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
get(id, organizationCode) Fetches User Object with additional data appended: GroupsCount, AppsCount
id | integer | User Id |
organizationCode | string | Organization Code |
returns | object | User object |
getRoles(id) Fetches User Roles
id | integer | User Id |
returns | object | Array of Role objects |
getByEmail(email) Fetches User Object by Email with additional data appended: GroupsCount, AppsCount
string, required | User Email | |
returns | object | User object |
getDevices(id) Fetches user Devices
id | integer, required | User Id |
returns | array | A list of user Devices |
getDevicesCount(id) Returns a number of user Devices
id | integer, required | User Id |
returns | integer | A list of user Devices |
getMessages() Fetches Messages for current User
returns | array | List of user Messages |
invite(email, firstName, lastName, title, avatar, company, department) Invites new user to Organization
string, required | User Email | |
firstName | string | User FirstName |
lastName | string | User LastName |
title | string | User Title |
avatar | string | User Avatar |
company | string | User Company |
department | string | User Department |
returns | integer | Id of created User object, JSON formatted error otherwise |
inviteMany(values)
values | array, required | |
returns | boolean |
setBlocked(id, blocked) Performs blocking of User
id | integer, required | User Id |
blocked | boolean, required | True/False |
returns | boolean | True in case of success, JSON formatted exception otherwise |
setDeleted(id, deleted) Performs "soft" deletion of User
id | integer, required | User Id |
deleted | boolean, default: true | True/False |
returns | boolean | True in case of success, JSON formatted exception otherwise |
update(id, email, firstName, lastName, title, avatar, password, changePasswordForAllOrgs, company, department) Updates current or specific User
id | integer | User Id |
string | New User Email | |
firstName | string | New User FirstName |
lastName | string | New User LastName |
title | string | New User Title |
avatar | string | New User Avatar |
password | string | New User Pasword |
changePasswordForAllOrgs | boolean, default: false | Set it to True if you want to change password in all orgs for that user |
company | string | User Company |
department | string | User Department |
returns | boolean | True in case of success, JSON formatted exception otherwise |
Group service
Group service provides a functional to manage user groups within your Sencha Web Application Manager Organization
Methods:
create(name, description) Creates a new Group
name | string, required | Group Name |
description | string | Group Description |
returns | integer | Id of created Group object, JSON formatted error otherwise |
delete(id) Deletes a Group
id | integer, required | Group Id |
returns | boolean | True in case of success, JSON formatted exception otherwise |
deleteAll(except) Performs deletion of all org Groups (except specified)
except | array | Specify an array of Group Ids you want to keep in your org |
returns | array | An array of Group Ids which have left in organization |
fetch(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of Groups
filter | string | Filter to apply to Group name |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
get(id) Fetches all the Group data
id | integer, required | Group Id |
returns | object | JSON formatted Group object which also contains Apps and Users count |
update(id, name, description) Performs Group updating
id | integer, required | Group Id |
name | string | New Group Name |
description | string | New Group Description |
returns | boolean | True in case of success, JSON formatted exception otherwise |
App service
App service provides a functional to manage Apps within your Sencha Web Application Manager Organization
Methods:
create(name, url, icon, description, intents, ordinal, landingPage, hidden) Creates a new Application
name | string, required | Name |
url | string, required | Url address |
icon | string | Url path to icon |
description | string | App description |
intents | array | App intents |
ordinal | integer, default: -1 | Set it to True to mark app as ordinal |
landingPage | boolean, default: false | App landing page |
hidden | boolean, default: false | App visibility setting for clients |
returns | integer | Id of created Application object, JSON formatted error otherwise |
delete(id) Deletes the Application
id | integer, required | App Id |
returns | boolean | True in case of success, JSON formatted exception otherwise |
deleteAll(except) Performs deletion of all org Applications (except specified)
except | array | Specify an array of App Ids you want to keep in your org |
returns | array | An array of App Ids which have left in organization |
fetch(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of Applications
filter | string | Filter to apply to App name or App description |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
get(id) Fetches all the Application data
id | integer, required | App Id |
returns | object | JSON formatted Application object which also contains Groups and Users count |
update(id, name, url, icon, description, intents, ordinal, landingPage, hidden) Performs Application updating
id | integer, required | App Id |
name | string | New name |
url | string | New url |
icon | string | New path to icon |
description | string | New description |
intents | array | New value for Intents |
ordinal | integer | New value for Ordinal |
landingPage | boolean | New value for Landing page |
hidden | boolean | App visibility setting for clients |
returns | boolean | True in case of success, JSON formatted exception otherwise |
mine() Provides a full list of user’s applications. Additional information for each app is also available: Deployed Version, Invoking app list, Policies, Vpn, Badge
returns | array | JSON formatted array of applications with additional information |
getInvokableApps(id) Provides a list of invokable apps for specified Application
id | integer, required | App Id |
returns | array | List of App Ids |
setInvokableApps(id, accessToAll, mode, apps) Updates list of invokable apps for specified application
id | integer, required | Application Id |
accessToAll | boolean, required | Set this param to True if you want to grant access to all apps |
mode | string, default: ‘multi’ | Application select mode, can be either ‘multy’ or ‘all’ |
apps | array | Application Ids to select. If mode is ‘multy’ specify a list of apps you want to grant access to, otherwise specify apps you want to exclude from granting access to |
returns | boolean | True in case of success, JSON formatted exception otherwise |
setDeleted(id, deleted) Performs "soft" deletion of application
id | integer, required | Application Id |
deleted | boolean, default: true | True/False |
returns | boolean | True in case of success, JSON formatted exception otherwise |
reorder(values)
values | array, required | |
returns | array |
Org service
Org service provides a functional to manage your Organization in Sencha Web Application Manager
Methods:
broadcast(message) Performs a broadcasting to all organization devices
message | string, required | Message to broadcast |
returns | boolean | True |
fetch() Fetches all the Organization information
returns | array | JSON formatted organization object which contains number of Users, Groups and Apps |
get() Fetches Organization object
returns | object | JSON formatted Organization object |
update(name, authType, saml, contact, uiParameters, ldap, pnSettings, emailTemplates)
name | string | |
authType | authenticationtype | |
saml | samlconfig | |
contact | contactinformation | |
uiParameters | object | |
ldap | ldapconfig | |
pnSettings | pnconfig | |
emailTemplates | emailtemplate | |
returns | boolean |
UserGroup service
UserGroup service provides a functional to manage your users within specific groups
Methods:
create(id, groups) Maps a list of groups to specific user
id | integer, required | User Id |
groups | array, required | List of Group Ids |
returns | array | List of Group Ids |
createAll(id, except) Maps all the organization groups to specific user
id | integer, required | User Id |
except | array | Specify an array of Group Ids you want leave unmapped |
returns | array | List of unmapped groups |
delete(id, groups) Deletes the mapping between specific User and list of Groups
id | integer, required | User Id |
groups | array, required | List of Group Ids |
returns | array | List of Group Ids |
deleteAll(id, except) Deletes the mapping between specific User and all Groups in organization
id | integer, required | User Id |
except | array | Specify an array of Groups you want to keep mapping for |
returns | array | Array of User Groups that have left after unmapping |
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor, excluded) Fetches a sorted limited list of User Groups
id | integer, required | User Id |
filter | string | Filter to apply to Group Name |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
excluded | boolean, default: false | Set to True in order to fetch groups where user is not involved |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
GroupUser service
GroupUser service provides a functional to manage your users within specific groups
Methods:
create(id, users) Maps a list of users to specific group
id | integer, required | Group Id |
users | array, required | List of User Ids |
returns | array | List of User Ids |
createAll(id, except) Maps all the organization users to specific group
id | integer, required | Group Id |
except | array | Specify an array of User Ids you want leave unmapped |
returns | array | List of unmapped users |
delete(id, users) Deletes the mapping between specific Group and list of Users
id | integer, required | Group Id |
users | array, required | List of User Ids |
returns | array | List of User Ids |
deleteAll(id, except) Deletes the mapping between specific Group and all Users in organization
id | integer, required | Group Id |
except | array | Specify an array of Users you want to keep mapping for |
returns | array | Array of Group Users that have left after unmapping |
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor, excluded) Fetches a sorted limited list of Group Users
id | integer, required | Group Id |
filter | string | Filter to apply to User Firstname, Lastname or Email |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
excluded | boolean, default: false | Set to True in order to fetch users that are not involved in specific group |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
UserApp service
UserApp service provides a functional to manage your Apps for specific users
Methods:
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor, includeAccessibleApps) Fetches a sorted limited list of User Applications
id | integer, required | User Id |
filter | string | Filter to apply to Application Name or Description |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
includeAccessibleApps | boolean, default: false | Set to True in order to fetch all apps user has access to (via Organization and Groups access settings) |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
AppUser service
AppUser service provides a functional to manage Application Users
Methods:
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor, includeAllUsers) Fetches a sorted limited list of Application Users
id | integer, required | Application Id |
filter | string | Filter to apply to User First Name, Last Name or Email |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
includeAllUsers | boolean, default: false | Set to True in order to fetch all users that has access to the app (via Organization and Groups access settings) |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
GroupApp service
GroupApp service provides a functional to manage your Apps within specific groups
Methods:
create(id, apps) Maps a list of apps to specific group
id | integer, required | Group Id |
apps | array, required | List of App Ids |
returns | array | List of Apps Ids |
createAll(id, except) Maps all the organization apps to specific group
id | integer, required | Group Id |
except | array | Specify an array of App Ids you want leave unmapped |
returns | array | List of unmapped apps |
delete(id, apps) Deletes the mapping between specific Group and list of Apps
id | integer, required | Group Id |
apps | array, required | List of App Ids |
returns | array | List of App Ids |
deleteAll(id, except) Deletes the mapping between specific Group and all Apps in organization
id | integer, required | Group Id |
except | array | Specify an array of Apps you want to keep mapping for |
returns | array | Array of Group Applications that have left after unmapping |
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor, excluded) Fetches a sorted limited list of Group Applications
id | integer, required | Group Id |
filter | string | Filter to apply to App name or description |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
excluded | boolean, default: false | Set to True in order to fetch applications that are not presented in specific group |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
AppGroup service
AppGroup service provides a functional to manage your Apps within specific groups
Methods:
create(id, groups) Maps a list of groups to specific app
id | integer, required | App Id |
groups | array, required | List of Group Ids |
returns | array | List of Group Ids |
createAll(id, except) Maps all the organization groups to specific app
id | integer, required | App Id |
except | array | Specify an array of Group Ids you want leave unmapped |
returns | array | List of unmapped groups |
delete(id, groups) Deletes the mapping between specific App and list of Groups
id | integer, required | Application Id |
groups | array, required | List of Group Ids |
returns | array | List of Group Ids |
deleteAll(id, except) Deletes the mapping between specific App and all Groups in organization
id | integer, required | App Id |
except | array | Specify an array of Groups you want to keep mapping for |
returns | array | Array of Application Groups that have left after unmapping |
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor, excluded) Fetches a sorted limited list of Application Groups
id | integer, required | Application Id |
filter | string | Filter to apply to Group name |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
excluded | boolean, default: false | Set to True in order to fetch groups where application is not involved |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
Session service
Session service provides a functional to manage your user’s sessions
Methods:
fetch(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of User Sessions
filter | string | Filter to apply to Session User FirstName, LastName or Email |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
kill(id) Kills specific Session
id | integer, required | Session Id |
returns | boolean | True in case of success, JSON formatted exception otherwise |
setActive(active) Changes Session State
active | boolean, default: true | If set to True, current session will be marked as ‘Active’, otherwise ‘Idle’ |
returns | object | True |
setDevice(id, clientVersion, make, model, os, osVersion, ipAddress, name, notificationsToken) Attaches Device to current session
id | string, required | Device Unique Id |
clientVersion | string, required | Device Client Version |
make | string, required | Device Make |
model | string, required | Device Model |
os | string, required | Device OS |
osVersion | string, required | Device OS Version |
ipAddress | string, required | Device IP address |
name | string | Device Name |
notificationsToken | string | Device Notification Token |
returns | boolean | A JSON formatted object, which contains: success and deviceId (if the operation was successful). |
Stats service
Stats service provides different types of system reports
Methods:
totals(visits, users, groups, apps, devices) Fetches total numbers of Visits, Users, Groups, Apps and Devices in the system
visits | boolean, default: false | Whether or not include Visits number to output |
users | boolean, default: false | Whether or not include Users number to output |
groups | boolean, default: false | Whether or not include Groups number to output |
apps | boolean, default: false | Whether or not include Apps number to output |
devices | boolean, default: false | Whether or not include Devices number to output |
returns | object | JSON formatted object which contains data above |
usersLogins(dateStart, dateEnd, dataPointCount) Fetches stats of number of user logins to the system
dateStart | string, required | Start Date |
dateEnd | string, required | End Date |
dataPointCount | integer, required | Number of data points |
returns | array | An array of data point objects, each consists of Key and Logins fields |
usersActivity(dateStart, dateEnd, dataPointCount) Fetches stats for users Activity
dateStart | string, required | Start Date |
dateEnd | string, required | End Date |
dataPointCount | integer, required | Number of data points |
returns | array | An array of data point objects, each consists of Key and Logins fields |
devicesCreated(dateStart, dateEnd, dataPointCount) Fetches stats of Device creations
dateStart | string, required | Start Date |
dateEnd | string, required | End Date |
dataPointCount | integer, required | Number of data points |
returns | array | An array of data point objects, each consists of Interval and Users fields |
usersCreated(dateStart, dateEnd, dataPointCount) Fetches stats of User creations
dateStart | string, required | Start Date |
dateEnd | string, required | End Date |
dataPointCount | integer, required | Number of data points |
returns | array | An array of data point objects, each consists of Interval and Users fields |
getUserFilters(dateStart, dateEnd) Fetches User filter options
dateStart | string, required | Start Date |
dateEnd | string, required | End Date |
returns | object | JSON formatted object which contains information above |
getAppFilters(dateStart, dateEnd) Fetches Bookmark filter options
dateStart | string, required | Start Date |
dateEnd | string, required | End Date |
returns | object | JSON formatted object which contains information above |
getDeviceFilters(dateStart, dateEnd) Fetches Device filter options grouped by Platforms, PlatformVersions, ClientVersions, DeviceOwnerships
dateStart | string, required | Start Date |
dateEnd | string, required | End Date |
returns | object | JSON formatted object which contains information above |
lastSeen(dateStart, dateEnd, dataPointCount, platform, platformVersion, deviceOwnership) Fetches Last Seen stats (DeviceActivity data)
dateStart | string | Start Date |
dateEnd | string | End Date |
dataPointCount | integer, default: 6 | Number of data points |
platform | string | Filter for platform |
platformVersion | string | Filter for platform version |
deviceOwnership | string | Filter for device ownership |
returns | array | An array of data point objects, each consists of Interval and Count fields |
platformDistribution(dateStart, dateEnd, platform, platformVersion, deviceOwnership) Fetches Device Platform Distribution stats
dateStart | string | Start Date |
dateEnd | string | End Date |
platform | string | Filter for platform |
platformVersion | string | Filter for platform version |
deviceOwnership | string | Filter for device ownership |
returns | array | An array of objects, each consists of name and value fields |
appLaunches(dateStart, dateEnd, dataPointCount, platform, platformVersion, deviceOwnership, id, userId) Fetches App Launches by devices stats
dateStart | string | Start Date |
dateEnd | string | End Date |
dataPointCount | integer, default: 10 | Number of data points |
platform | string | Filter for platform |
platformVersion | string | Filter for platform version |
deviceOwnership | string | Filter for device ownership |
id | integer | Application Id |
userId | integer | Filter for user |
returns | array | An array of Launches values, single value for each datapoint |
getAppLaunches(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of Applications launches (groupped by app)
filter | object | Request Filter, JSON formatted object which could contain such filters for device object: dateStart, dateEnd, userId, active, platform, platformVersion, deviceOwnership |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
getAppLaunchesByUser(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of Applications launches (groupped by user)
filter | object | Request Filter, JSON formatted object which could contain such filters for device object: dateStart, dateEnd, userId, active, platform, platformVersion, deviceOwnership |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
inAppEventsDistribution(id, limit, dateStart, dateEnd) Fetches In-App Events Distribution stats
id | integer, required | Application Id |
limit | integer, default: 10 | Limit |
dateStart | string | Start Date |
dateEnd | string | End Date |
returns | array | An array of objects, each consists of name and value fields |
Device service
Device service provides a functional to manage your user’s devices
Methods:
fetch(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of Devices
filter | jtoken | Request Filter, could be either a string to apply to Device name, or JSON formatted object which could contain such filters: dateStart, dateEnd, userId, active, platform, platformVersion, deviceOwnership, name, inactiveDays (int), access |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
get(id) Fetches Device Object with additional data appended: LastActive, LastSession, User
id | integer, required | Device Id |
returns | object | Device object |
authorize(id, authorized) Performs authorization/deauthorization of Device
id | integer, required | Device Id |
authorized | boolean, required | True/False |
returns | boolean | True in case of success, JSON formatted exception otherwise |
setDeleted(id, deleted) Performs "soft" deletion of Device
id | integer, required | Device Id |
deleted | boolean, required | True/False |
returns | boolean | True in case of success, JSON formatted exception otherwise |
setOwnership(id, ownership) Updates Device ownership
id | integer, required | Device Id |
ownership | string, required | Ownership, could be either: ‘Unknown’, ‘Employee’ or ‘Corporate’ |
returns | boolean | True in case of success, JSON formatted exception otherwise |
wipe(id) Wipes device
id | integer, required | Device Id |
returns | boolean | True in case of success, JSON formatted exception otherwise |
OrgSecurityPolicy service
OrgSecurityPolicy service provides a functional to manage security settings of your Sencha Web Application Manager Organization
Methods:
getPolicies() Fetches Security Policy Rules and Values for Organization
returns | array | JSON formatted object with Policies |
update(policies) Performs an update of Organization security Policies
policies | object, required | JSON formatted object which contains {Policy Rule Id : Security Policy Value} pairs, like {24:‘policyValue’} |
returns | boolean | True if success, JSON formatted exception otherwise |
UserSecurityPolicy service
UserSecurityPolicy service provides a functional to manage security settings of specific user in your Sencha Web Application Manager Organization
Methods:
getPolicies(id) Fetches Security Policy Rules and Values for specific User
id | integer, required | User Id |
returns | array | JSON formatted object with Policies |
update(id, policies) Performs an update of User security Policies
id | integer, required | User Id |
policies | object, required | JSON formatted object which contains {Policy Rule Id : Security Policy Value} pairs, like {24:‘policyValue’} |
returns | boolean | True if success, JSON formatted exception otherwise |
fetchPolicies(id) Fetches Signed Security Policy Values for specific User
id | integer | User Id |
returns | array | List of Policy Values |
AppSecurityPolicy service
AppSecurityPolicy service provides a functional to manage security settings of specific application in your Sencha Web Application Manager Organization
Methods:
getPolicies(id, except) Fetches Security Policy Rules and Values for specific App
id | integer, required | Application Id |
except | array | Array of Security Policy Names to exclude from output |
returns | array | JSON formatted object with Policies |
update(id, policies) Performs an update of Application security Policies
id | integer, required | Application Id |
policies | object, required | JSON formatted object which contains {Policy Rule Id : Security Policy Value} pairs, like {24:‘policyValue’} |
returns | boolean | True if success, JSON formatted exception otherwise |
fetchPolicies(id) Fetches Security Policy Values for specific Application
id | integer, required | Application Id |
returns | array | List of Policy Values |
InvokableApp service
InvokableApp service provides a functional to manage invoke settings for specific application in your Sencha Web Application Manager Organization
Methods:
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of Invokable Apps for specific Application
id | integer, required | Application Id |
filter | string | Filter to apply to App name or description |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
Subscription service
Subscription service provide a functional to manage your Sencha Web Application Manager Subscription and Billing settings
Methods:
update(planId, card)
planId | string | |
card | creditcard | |
returns | object |
fetchHistory(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited Billing history
filter | jtoken | Request Filter, JSON formatted object which could contain such filters: dateStart, dateEnd |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
get() Returns current subscription
returns | object | JSON formatted Subscription object |
Vpn service
Vpn service provides a functional to manage VPNs within your Sencha Web Application Manager Organization
Methods:
create(name, authUrl, apps) Creates a VPN and maps it to specific Apps
name | string, required | VPN Name |
authUrl | string, required | VPN Auth Url |
apps | array | List of App Ids |
returns | integer | VPN Id in case of success, JSON formatted error otherwise |
delete(id) Deletes specific VPN
id | integer, required | VPN Id |
returns | boolean | True in case of success, JSON formatted exception otherwise |
deleteAll(except) Performs deletion of all org VPNs (except specified)
except | array | Specify an array of VPN Ids you want to keep in your org |
returns | array | An array of VPN Ids which have left in organization |
fetch(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of VPNs
filter | string | Filter to apply to VPN Name |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
get(id) Fetches VPN Object with additional data appended: Apps
id | integer, required | VPN Id |
returns | object | VPN object with Apps appended |
update(id, name, authUrl, apps) Updates VPN object
id | integer, required | VPN Id |
name | string | New VPN Name |
authUrl | string | New VPN Auth Url |
apps | array | New VPN List of Apps |
returns | boolean | True in case of success, JSON formatted exception otherwise |
VpnApp service
VpnApp service provides a functional to manage your VPNs for specific applications
Methods:
create(id, apps) Maps a list of apps to specific vpn
id | integer, required | VPN Id |
apps | array, required | List of App Ids |
returns | array | List of App Ids |
createAll(id, except) Maps all the organization Apps to specific Vpn
id | integer, required | VPN Id |
except | array | Specify an array of App Ids you want leave unmapped |
returns | array | List of unmapped apps |
delete(id, apps) Deletes the mapping between specific VPN and list of Apps
id | integer, required | VPN Id |
apps | array, required | List of App Ids |
returns | array | List of App Ids |
deleteAll(id, except) Delete the mapping between specific VPN and all Apps in organization
id | integer, required | User Id |
except | array | Specify an array of Apps you want to keep mapping for |
returns | array | Array of Apps that have left after unmapping |
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor, excluded) Fetches a sorted limited list of VPN Apps
id | integer, required | VPN Id |
filter | jtoken | Filter to apply to App Name or Description |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
excluded | boolean, default: false | Set to True in order to fetch applications where specific VPN is not attached |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
DataTransfer service
DataTransfer service provides a functional to import/export different types of entities within your Sencha Web Application Manager Organization
Methods:
importUsersAndGroupsFromCSV(positionEmail, positionFirstName, positionLastName, positionGroupName) Performs Users and Groups import from CSV input file; Input file should be appended to RPC POST request
positionEmail | integer, required | Position of Email Address in file record |
positionFirstName | integer | Position of First Name in file record |
positionLastName | integer | Position of Last Name in file record |
positionGroupName | integer | Position of Group Name in file record |
returns | object | True if success, JSON formatted exception otherwise |
importUsersAndGroupsFromLDIF(attributeNameEmail, attributeNameFirstName, attributeNameLastName, attributeNameGroupName) Performs Users and Groups import from LDIF input file; Input file should be appended to RPC POST request
attributeNameEmail | string, required | Name of attribute in record which will be considered as Email address |
attributeNameFirstName | string | Name of attribute in record which will be considered as First Name |
attributeNameLastName | string | Name of attribute in record which will be considered as Last Name |
attributeNameGroupName | string | Name of attribute in record which will be considered as Group Name |
returns | object | True if success, JSON formatted exception otherwise |
getLastJobStatus() Provides status of last Data Transfer Job
returns | object | JSON formatted Data Transfer Job object |
exportEventsAsCSV(dateStart, dateEnd, separator, includeHeaders) Schedules export of Audit Data
dateStart | string | Start Date |
dateEnd | string | End Date |
separator | string, default: ‘,’ | Separator for fields in record |
includeHeaders | boolean, default: true | If set to true field names would be appended to export |
returns | object | True if success, JSON formatted exception otherwise; Output file will be available after export job execution |
fetchExportJobs(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of Audit Data export jobs
filter | string | Unused |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
Push service
Push service provides a functional to send push notifications to application users within your Sencha Web Application Manager Organization
Methods:
notification(bookmarkId, userEmail, data, badge, alert) Sends a push notification to application User/Users
bookmarkId | integer, required | Application Id |
userEmail | string | User Email |
data | string | Payload data |
badge | string | Badge |
alert | object | Alert |
returns | object | JSON formatted object which contains notifications that have been sent, error otherwise |
Badge service
Badge service provides a functional to manage application Badges within your Sencha Web Application Manager Organization
Methods:
update(bookmarkId, value, deviceId) Updates an application Badge
bookmarkId | integer, required | Application Id |
value | string, required | New Badge Value |
deviceId | string | Device Id |
returns | boolean | True in case of success, JSON formatted exception otherwise |
UserRole service
UserRole service provides a functional to manage UserRoles within your Sencha Web Application Manager Organization
Methods:
create(name, permissions) Creates a new User Role
name | string, required | User Role Name |
permissions | integer, required | Permission list for new role, which is calculated by bitwise-inclusive-OR of needed permissions, which could be: UserPermissions = 0, InventoryRead = 1, InventoryModify = 2, AnalyticsRead = 4, SettingsRead = 8, SettingsModify = 16, BillingRead = 32, BillingModify = 64, RolesModify = 128, |
returns | integer | Id of created Role object, JSON formatted error otherwise |
delete(id) Deletes a User Role
id | integer, required | Role Id |
returns | boolean | True in case of success, JSON formatted exception otherwise |
deleteAll(except) Performs deletion of all org Roles (except specified)
except | array | Specify an array of Role Ids you want to keep in your org |
returns | array | An array of Role Ids which have left in organization |
fetch(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of Roles
filter | string | Filter to apply to Role name |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
update(id, name, permissions) Updates existing User Role
id | integer, required | Role Id |
name | string | New Role Name |
permissions | integer | New Role Permisions |
returns | boolean | True in case of success, JSON formatted exception otherwise |
UserUserRole service
UserUserRole service provides a functional to manage User UserRoles within your Sencha Web Application Manager Organization
Methods:
create(id, roles) Maps a list of Roles to specific user
id | integer, required | User Id |
roles | array, required | List of Role Ids |
returns | array | List of Role Ids |
delete(id, roles) Deletes the mapping between specific User and list of Roles
id | integer, required | User Id |
roles | array, required | List of Role Ids |
returns | array | List of Role Ids |
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor, excluded) Fetches a sorted limited list of User Roles
id | integer, required | User Id |
filter | string | Filter to apply to Role Name |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
excluded | boolean, default: false | Set to True in order to fetch roles user in not granted with |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
UserRoleUser service
UserRoleUser service provides a functional to manage UserRole Users within your Sencha Web Application Manager Organization
Methods:
create(id, users) Maps a list of users to specific role
id | integer, required | Role Id |
users | array, required | List of User Ids |
returns | array | List of User Ids |
delete(id, users) Deletes the mapping between specific Role and list of Users
id | integer, required | Role Id |
users | array, required | List of User Ids |
returns | array | List of User Ids |
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor, excluded) Fetches a sorted limited list of Role users
id | integer, required | Role Id |
filter | string | Filter to apply to User LastName, FirstName or Email |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
excluded | boolean, default: false | Set to True in order to fetch users that are not granted with specific role |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
Version service
Version service provides a functional to manage application Versions within your Sencha Web Application Manager Organization
Methods:
fetch(id, filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of App Versions
id | integer, required | Application Id |
filter | string | Filter to apply to Version Name |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
create(id, name, pathToArchive, pathToDeployedApp) Creates a new Version either by specifying remote path to app archive, remote path to deployed app or attach app archive to current RPC POST request
id | integer, required | Application Id |
name | string, required | Version Name |
pathToArchive | string | Remote Path to App archive |
pathToDeployedApp | string | Remote Path to Deployed App |
returns | object | Version object in case of success, JSON formatted exception otherwise |
delete(id) Deletes a Version
id | integer, required | Version Id |
returns | boolean | True in case of success, JSON formatted exception otherwise |
update(id, name, pathToArchive, pathToDeployedApp) Updates existing Version
id | integer, required | Version Id |
name | string | New Version Name |
pathToArchive | string | New Version Remote Path to App archive |
pathToDeployedApp | string | New Version Remote Path to Deployed App |
returns | boolean | True in case of success, JSON formatted exception otherwise |
setDeployed(id, deploy) Performs Version deploying/undeploying
id | integer, required | Version Id |
deploy | boolean, default: true | True/False |
returns | boolean | True in case of success, JSON formatted exception otherwise |
get(id) Fetches Version object
id | integer, required | Version Id |
returns | object | JSON formatted Version object |
InAppEvent service
InAppEvent service provides a functional to manage in-application events within your Sencha Web Application Manager Organization
Methods:
fetch(id, userId, filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of In-Application events
id | integer | Application Id |
userId | integer | User Id (takes precedence over filter.userId) |
filter | jtoken | Request Filter, JSON formatted object which could contain such filters: dateStart, dateEnd, userId, deviceId, userAlternateId, userEmail, deviceUniqueId, deviceName, devicePlatform, devicePlatformVersion, ipAddress, category, action, label, valueMin, valueMax |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |
BookmarkAccess service
BookmarkAccess service provides a functional to manage application access logs within your Sencha Web Application Manager Organization
Methods:
fetch(filter, sortBy, sortDirection, limit, direction, cursor) Fetches a sorted limited list of Bookmark Accesses
filter | jtoken | Request Filter, JSON formatted object which could contain such filters: dateStart, dateEnd, userId, deviceId, userEmail, deviceUniqueId, deviceName, devicePlatform, devicePlatformVersion, query, appId |
sortBy | string | Field in result to sort by |
sortDirection | string | Sort direction, could be either ‘asc’ or ‘desc’ |
limit | integer, default: 20 | Limit of output items |
direction | string, default: ‘after’ | Direction of fetching items relatively to cursor, could be either ‘after’ or ‘before’ |
cursor | integer, default: 0 | Request cursor |
returns | object | A JSON formatted object, which contains: startCursor, endCursor, total (number of items), items |