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
/v2/session
/v2/session
/v2/session
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:
|
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:
|
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 }