...
...
General Information
...
| Service | API | Method | Data Models | Workflow | Group |
|---|---|---|---|---|---|
| multitenant | /admin/tenant/applications | GET | Tenant | N/A | Admin tenant |
Description
List tenant applications
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|---|---|---|---|---|
| id | Query | YES | String | N/A | Tenant ID |
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
result: true,
data: [
{
"product": "TPROD",
"package": "TPROD_BASIC",
"appId": "30d2cb5fc04ce51e06000001",
"description": "this is a description for app for test tenant for test product and basic package",
"_TTL": 7 * 24 * 3600 * 1000, // 7 days hours
"keys": [
{
"key": "d1eaaf5fdc35c11119330a8a0273fee9",
"extKeys": [
{
"expDate": new Date().getTime() + 7 * 24 * 3600 * 1000, // + 7 days
"extKey": "aa39b5490c4a4ed0e56d7ec1232a428f771e8bb83cfcee16de14f735d0f5da587d5968ec4f785e38570902fd24e0b522b46cb171872d1ea038e88328e7d973ff47d9392f72b2d49566209eb88eb60aed8534a965cf30072c39565bd8d72f68ac",
"dashboardAccess": true,
"device": {},
"geo": {}
}
],
"config": {
"dev": {
"oauth": {
"loginMode": 'urac'
},
"mail": {
"from": 'me@localhost.com',
"transport": {
"type": "sendmail",
"options": {}
}
},
"urac": {
"hashIterations": 1024, //used by hasher
"seedLength": 32, //used by hasher
"link": {
"addUser": "http://dashboard.soajs.org/#/setNewPassword",
"changeEmail": "http://dashboard.soajs.org/#/changeEmail/validate",
"forgotPassword": "http://dashboard.soajs.org/#/resetPassword",
"join": "http://dashboard.soajs.org/#/join/validate"
},
"tokenExpiryTTL": 2 * 24 * 3600 * 1000,// token expiry limit in seconds
"validateJoin": true, //true if registration needs validation
"mail": { //urac mail options
"join": {
"subject": 'Welcome to SOAJS'
},
"forgotPassword": {
"subject": 'Reset Your Password at SOAJS'
},
"addUser": {
"subject": 'Account Created at SOAJS'
},
"changeUserStatus": {
"subject": "Account Status changed at SOAJS",
//use custom HTML
"content": "<p>Dear <b>{{ username }}</b>, <br />The administrator update your account status to <b>{{ status }}</b> on {{ts}}.<br /><br />Regards,<br/>SOAJS Team.</p>"
},
"changeEmail": {
"subject": "Change Account Email at SOAJS"
}
}
},
"dashboard": {
"ownerPackage": "DSBRD_OWNER",
"defaultClientPackage": "DSBRD_CLIENT",
"clientspackage": {}
},
"commonFields": {
"SOAJS_SAAS": {},
"HT_PROJECT": {
"name": "demo"
}
}
}
}
}
]
},
{
"product": "TPROD",
"package": "TPROD_BASIC",
"appId": "30d2cb5fc04ce51e06000002",
"description": "this is a description for app for test tenant for test product and basic package, and with example03 in acl",
"_TTL": 86400000, // 24 hours
"keys": [
{
"key": "695d3456de70fddc9e1e60a6d85b97d3",
"extKeys": [
{
"expDate": new Date().getTime() + 86400000,
"extKey": "aa39b5490c4a4ed0e56d7ec1232a428f7ad78ebb7347db3fc9875cb10c2bce39bbf8aabacf9e00420afb580b15698c04ce10d659d1972ebc53e76b6bbae0c113bee1e23062800bc830e4c329ca913fefebd1f1222295cf2eb5486224044b4d0c",
"device": {},
"geo": {}
}
],
"config": {
"dev": {
"commonFields": {
"SOAJS_SAAS": {
"demo": {}
}
},
"oauth": {
"loginMode": 'urac'
},
"urac": {
"hashIterations": 1024, //used by hasher
"seedLength": 32, //used by hasher
"tokenExpiryTTL": 2 * 24 * 3600 * 1000
}
}
}
}
]
},
{
"product": "TPROD",
"package": "TPROD_EXAMPLE03",
"appId": "30d2cb5fc04ce51e06000003",
"description": "this is a description for app for test tenant for test product and example03 package",
"_TTL": 86400000, // 24 hours
"keys": [
{
"key": "ff7b65bb252201121f1be95adc08f44a",
"extKeys": [
{
"expDate": new Date().getTime() + 86400000,
"extKey": "aa39b5490c4a4ed0e56d7ec1232a428f1c5b5dcabc0788ce563402e233386738fc3eb18234a486ce1667cf70bd0e8b08890a86126cf1aa8d38f84606d8a6346359a61678428343e01319e0b784bc7e2ca267bbaafccffcb6174206e8c83f2a25",
"device": {},
"geo": {}
}
],
"config": {
"dev": {
"commonFields": {},
"oauth": {
"loginMode": 'urac'
},
"urac": {
"hashIterations": 1024, //used by hasher
"seedLength": 32, //used by hasher
"tokenExpiryTTL": 2 * 24 * 3600 * 1000
}
}
}
}
]
}
]
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
} |
Response schema
Follow this link to check out the response JSON response JSON Schema
SOAJS Error Codes
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
| 450 | Unable to find tenant |
| 602 | Model error: + %model_error% |