Launch Pad System Calls

The Launchpad System API Calls help you Log In, Log Out, and fetch the session data for a logged in user. Once logged in, users can avail of the services they are entitled to.

API Calls
Get

/v2/session

Post

/v2/session

Delete

/v2/session

Get Logged-In User Session Data

Description Retrieves session data for a logged-in user.
Who Can Execute? Any user can execute this API call.
Syntax
GET <Base_URL>/session
Sample code
GET https://dashboard.mojonetworks.com/api/v2/session
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains session
data for a logged-in user. The response is in the application/json format.

Log In to Launchpad

Description Log’s into Mojo LaunchPad using a valid key ID value pair.
Who Can Execute? Any user can execute this API call.
Syntax
POST /session
Sample code
POST https://dashboard.mojonetworks.com/api/v2/session
Request Body This API call requires the authentication type and the corresponding key ID-value pair for login,
which are passed as parameters in the request body. The timeout value is provided optionally. The
parameters are passed in the application/json format.

{
   "type": "apiKeyCredentials",
   "keyId": "KEY-ATN0-1",
   "keyValue": "aeaba3cad138a1aa4c3993d9b90e38e8",
   "timeout": 3600
}
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the
details of the key, which is similar to a user object, used to log in. The response is in the application/
json format.

Log Out

Description Log’s out from Launchpad to end the corresponding session.
Who Can Execute? Any user can execute this API call.
Syntax
DELETE <Base_URL>/session
Sample code
DELETE https://dashboard.mojonetworks.com/api/v2/session
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 204 No Content.
The response body does not contain any other information.

Post APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Delete APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Test APIs

Description This API is used to fetch the APs that match the specified filter criteria from the allowed locations for the logged-in user. If no filters are specified, all the APs from the allowed locations are fetched. However, this API is not supported in a server cluster environment.

Note: Do not use this API to fetch more than 100 devices. For fetching larger number of devices, consider using the Get Paged List of APs API.
User Privileges Users with the following roles can call this API: superuser, administrator, and operator.

Request Body Parameters
This API call does not require any request body parameters.

Response Body
If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.

Error codes
If the API call is successful, the HTTP response status is 200.
Syntax
GET /devices/aps
Sample code
GET https://training.mojonetworks.com/new/webservice/v2/devices/aps
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?macaddress=00:11:74:33:23:12&macaddress=00:11:74:45:12:21
GET
https://training.mojonetworks.com/new/webservice/v2/devices/aps?capability=49&locationid=10&locationid=12&sortcolumn=devicename&sortascending=false
URL Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Query Parameters This API call takes optional URL parameters to filter the list of APs to be fetched and the column on which the output must be sorted. AP Filter Parameters lists the parmeter names, datatypes, applicable values, and whether the results can be sorted based on the parameter.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains the details of the APs that match the filter criteria. The response is in the application/json format. Click AP to view the complete detais of the JSON along with a sample output.
JSON Table

Attribute Data Type Description
kid int A key ID of logged in user.
profileId int Assigned profile id of logged-in key
displayName String Full name of logged-in key.
timeZone String Timezone of logged-in key.
userManagement int If logged in user has user management permission. Values are 0 and 1
indicating no access and access respectively.
serviceManagement int If logged in user has service management permission. Values are 0 and
1 indicating no access and access respectively.
lockoutPolicy int If logged in user has settings permission. Values are 0 and 1 indicating
no access and access respectively.
resourceManagement int If logged in user has resource management permission. Values are 0 and
1 indicating no access and access respectively.
customerManagement int If logged in user has customer management permission. Values are 0 and
1 indicating no access and access respectively.
selfOrganizationAdmin boolean A true or false value indicating, whether logged-in key is admin on
his organization or not.
globalCustomerAdmin boolean A true or false value indicating, whether logged-in key is admin on
his organization or not.
customerGroupType int Customer group type of logged-in user. Possible values:

  • 0 – For all the customers.
  • 1 – For any other customer group
    type.
accessOnAllCustomers boolean A true or false value indicating, whether logged-in key has access on
all customers or not.
hideAdminPii boolean A true or false value indicating, whether users PII information is hidden
or not.
hideCredentials boolean A true or false value indicating, whether credential information is
hidden or not.
piiFeatureEnabled boolean A true or false value indicating, whether pii feature is enable or not.
language String A language used for logged-in user.
userOrganizationType int Indicating if logged in user is cloud operator. Possible values are:

  • 1 – Cloud operator
  • 2 – MSP/Customer
federationLoginEntitlement boolean A true or false value indicating, whether logged-in key’s organization
has federation enable or not.
manageServiceProvider boolean If logged in user is MSP or customer.
cToken String C Token for security.
exposedCid String Customer exposed ID of logged-in key.
optOutRootAdminAccess boolean A true or false value indicating, whether logged-in key do has admin
access on customer account or not.
multiFactAuthEnabled boolean A true or false value indicating, whether multiple factor authentication
is on for logged-in key or not.
multiFactAuthForceEnabled boolean A true or false value indicating, whether enforce multifactor authencation
enable for logged-in key or not.

Sample JSON 
{
	"kid": 1,
	"profileId": -1,
	"displayName": "Service Key",
	"timeZone": "UTC",
	"userManagement": 1,
	"keyManagement": 1,
	"serviceManagement": 0,
	"lockoutPolicy": 1,
	"resourceManagement": 1,
	"customerManagement": 1,
	"selfOrganizationAdmin": true,
	"globalCustomerAdmin": true,
	"customerGroupType": 0,
	"accessOnAllCustomers": true,
	"hideAdminPii": false,
	"hideCredentials": false,
	"piiFeatureEnabled": true,
	"language": "en",
	"userOrganizationType": 1,
	"federationLoginEntitlement": true,
	"manageServiceProvider": true,
	"cToken": "gsMTXhDtV4J70oxaJoxak4x91AEZfRwH",
	"exposedCid": "ATN0",
	"inactivity_timeout": 3600,
	"optOutRootAdminAccess": false,
	"multiFactAuthEnabled": false,
	"multiFactAuthForceEnabled": false
}