General Information
...
| Service | API | Method | Data Model | Workflow |
|---|---|---|---|---|
| multitenant | /products/console | GET | Products | N/A |
Description
This API lists all the products that exist in the console tenant.
Input
...
Type: application/son
No input data for this API
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": [
{
"_id": "5d7764841e2c4b034b43ceea",
"code": "DSBRD",
"name": "Console UI Product",
"description": "This is the main Console UI Product.",
"console": true,
"scope": {
"acl": {
"dashboard": {
"urac": {
"2": {
"access": true,
"apisPermission": "restricted",
"get": [
{
"group": "Administration",
"apis": {
"/admin/all": {
"access": true
},
"/admin/listUsers": {
"access": true
},
"/admin/changeUserStatus": {
"access": true
},
"/admin/group/list": {
"access": true
}
}
},
{
"group": "My Account",
"apis": {
"/account/getUser": {
"access": true
}
}
},
{
"group": "Guest Password Settings",
"apis": {
"/forgotPassword": {
"access": false
}
}
},
{
"group": "Guest Email Validation",
"apis": {
"/changeEmail/validate": {
"access": true
}
}
}
],
"post": [
{
"group": "My Account",
"apis": {
"/account/changeEmail": {
"access": true
},
"/account/changePassword": {
"access": true
},
"/account/editProfile": {
"access": true
}
}
},
{
"group": "Administration",
"apis": {
"/admin/addUser": {
"access": true
},
"/admin/editUser": {
"access": true
},
"/admin/group/add": {
"access": true
},
"/admin/group/edit": {
"access": true
}
}
},
{
"group": "Guest Password Settings",
"apis": {
"/resetPassword": {
"access": false
}
}
}
],
"delete": [
{
"group": "Administration",
"apis": {
"/admin/group/delete": {
"access": true
}
}
}
]
}
},
"dashboard": {
"1": {
"access": false,
"post": [
{
"group": "Continuous Delivery Deployment",
"apis": {
"/cd/deploy": {
"access": false
}
}
}
]
}
},
"oauth": {
"1": {
"access": true,
"apisPermission": "restricted",
"delete": [
{
"group": "Tokenization",
"apis": {
"/refreshToken/:token": {
"access": true
},
"/accessToken/:token": {
"access": true
}
}
},
{
"group": "User Tokenization",
"apis": {
"/tokens/user/:userId": {
"access": true
}
}
},
{
"group": "Cient Tokenization",
"apis": {
"/tokens/tenant/:clientId": {
"access": true
}
}
}
],
"post": [
{
"group": "Tokenization",
"apis": {
"/pin": {
"access": true
}
}
},
{
"group": "Guest",
"apis": {
"/token": {
"access": false
}
}
}
],
"get": [
{
"group": "Guest",
"apis": {
"/authorization": {
"access": false
}
}
}
]
}
},
"multitenant": {
"1": {
"access": false,
"get": [
{
"group": "Product"
},
{
"group": "Tenant"
},
],
"post": [
{
"group": "Product"
},
{
"group": "Tenant"
},
],
"put": [
{
"group": "Product"
},
{
"group": "Tenant"
},
],
"delete": [
{
"group": "Product"
},
{
"group": "Tenant"
},
]
}
},
}
}
},
"packages": [
{
"code": "DSBRD_GUEST",
"name": "Guest",
"description": "This package is used to provide anyone access to login and forgot password. Once logged in the package linked to the user tenant will take over thus providing the right access to the logged in user.",
"acl": {
"dashboard": {
"urac": [
{
"version": "2",
"post": [
"Guest Password Settings"
],
"get": [
"Guest Password Settings",
"Guest Email Validation"
]
}
],
"multitenant": [
{
"version": "1",
"get": [
"Product",
"Tenant"
],
"post": [
"Product",
"Tenant"
],
"delete": [
"Product",
"Tenant"
],
"put": [
"Product",
"Tenant"
]
}
]
}
},
"_TTL": 604800000
},
{
"code": "DSBRD_OWNER",
"name": "Owner",
"description": "This package is used to provide owner level access. This means the user who has this package will have access to everything.",
"acl": {
"dashboard": {
"oauth": [
{
"version": "1",
"get": [
"Guest"
],
"post": [
"Guest",
"Tokenization"
],
"delete": [
"Tokenization",
"User Tokenization",
"Cient Tokenization"
]
}
],
"urac": [
{
"version": "2",
"get": [
"Guest Email Account Settings",
"Administration",
"My Account",
"Guest Password Settings",
"Guest Email Validation"
],
"post": [
"Administration",
"My Account",
"Guest Password Settings"
],
"delete": [
"Administration"
]
}
],
"dashboard": [
{
"version": "1",
"get": [
"Environment",
],
"post": [
"Environment",
],
"put": [
"Environment",
],
"delete": [
"Environment",
]
}
],
"multitenant": [
{
"version": "1",
"get": [
"Product",
"Tenant"
],
"post": [
"Product",
"Tenant"
],
"delete": [
"Product",
"Tenant"
],
"put": [
"Product",
"Tenant"
]
}
]
}
},
"_TTL": 604800000
}
]
}
]
} |
Invalid Response
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":460,
"message":"Unable to find products"
}
]
}
} |
| Code | Description |
|---|---|
| 602 | Model error: + %model_error% |
...