Core
API v1.x
1

getProfile #

Gets a security profile.


Query Syntax #

HTTP #

Copied to clipboard!
URL: http://kuzzle:7512/profiles/<_id>
Method: GET

Other protocols #

Copied to clipboard!
{
  "controller": "security",
  "action": "getProfile",
  "_id": "<profileId>"
}

Arguments #

  • _id: profile identifier

Response #

Returns the queried profile information:

  • _id: profile identifier
  • _source: profile content
Copied to clipboard!
{
  "status": 200,
  "error": null,
  "result": {
    "_id": "<profileId>",
    "_source": {
      "policies": [
        {
          "roleId": "<roleId>"
        },
        {
          "roleId": "<roleId>",
          "restrictedTo": [
            {
              "index": "<index>"
            },
            {
              "index": "<index>",
              "collections": [
                "<coll1>",
                "<coll2>"
              ]
            }
          ]
        }
      ]
    },
    "action": "getProfile",
    "controller": "security",
    "requestId": "<unique request identifier>"
  }
}