mGetProfiles #

Gets multiple security profiles.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/profiles/_mGet
Method: POST
Body:

{
  "ids": ["profile1", "profile2"]
}

Other protocols #

{
  "controller": "security",
  "action": "mGetProfiles",
  "body": {
    "ids": ["profile1", "profile2"]
  }
}

Body properties #

ids: an array of profile identifiers to get

Response #

Returns a hits array of objects. Each object is a profile description, with the following properties:

_id: profile unique identifier
_source: profile description

{
  "status": 200,
  "error": null,
  "action": "mGetProfiles",
  "controller": "security",
  "requestId": "<unique request identifier>",
  "result": {
    "hits": [
      {
        "_id": "profile1",
        "_source": {
          "rateLimit": 0,
          "policies": [{"roleId": "admin"}]
        }
      },
      {
        "_id": "profile2",
        "_source": {
          "rateLimit": 50,
          "policies": [{"roleId": "default"}]
        }
      }
    ]
  }
}

Edit this page on Github