Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

General Information


 ServiceAPIMethod
 multitenant/products/consoleGET


Workflow:

Output


Valid Response

Valid Response Sample
{
  "result": true,
  "data": [
    {
      "_id": "5d7764841e2c4b034b43ceea",
      "locked": true,
      "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
                      }
                    }
                  }
                ],
                "post": [
                  {
                    "group": "My Account",
                    "apis": {
                      "/account/changeEmail": {
                        "access": true
                      },
                      "/account/changePassword": {
                        "access": true
                      },
                      "/account/editProfile": {
                        "access": true
                      }
                    }
                  }
                ],
                "delete": [
                  {
                    "group": "Administration",
                    "apis": {
                      "/admin/group/delete": {
                        "access": true
                      }
                    }
                  }
                ]
              }
            },
            "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",
          "locked": true,
          "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.",
          "locked": true,
          "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

Error Response Sample
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":460,
                "message":"Unable to find products"
            }
        ]
    }
}



Error Codes


 CodeDescription
 602Model error: + %model_error%
Example (CURL)

Request

Calling List Console Products API
 > CURL -X GET http://127.0.0.1:4004/products/console

Response

List Console Products API response
{
   "result": true,
   "data": [
      {
         
      },
      {
         
      }
   ]
}
  • No labels