createOrReplaceProfile #

Creates a new profile or, if the provided profile identifier already exists, replaces it.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/profiles/<_id>[?refresh=wait_for][&strict]
Method: PUT
Body:

{
  "rateLimit": 50,
  "tags": ["moderators"],
  "policies": [
    {
      "roleId": "<roleId>"
    },
    {
      "roleId": "<anotherRoleId>",
      "restrictedTo": [
        {
          "index": "<index>"
        },
        {
          "index": "<index>",
          "collections": [
            "<coll1>",
            "<coll2>"
          ]
        }
      ]
    }
  ]
}

Other protocols #

{
  "controller": "security",
  "action": "createOrReplaceProfile",
  "_id": "<profileId>",
  "body": {
    "rateLimit": 50,
    "tags": ["moderators"],
    "policies": [
      {
        "roleId": "<anotherRoleId>"
      },
      {
        "roleId": "<roleId>",
        "restrictedTo": [
          {
            "index": "<index>"
          },
          {
            "index": "<index>",
            "collections": [
              "<coll1>",
              "<coll2>"
            ]
          }
        ]
      }
    ]
  },
  // Optional parameters
  "refresh": "wait_for",
  "strict": true
}

Arguments #

_id: profile identifier

Optional: #

refresh: if set to wait_for, Kuzzle will not respond until the created/replaced profile is indexed (default: "wait_for")
strict (default: false): if set to true, will only allow the profile to be restricted on existing indexes or collections
Available since 2.6.0

Body properties #

See the profile definition guide.

Response #

Returns an object with the new profile modification status:

_id: created/replaced profile identifier
_source: profile content
created: if true, the profile has been created. Otherwise, it has been replaced
version: updated version number of the profile

{
  "status": 200,
  "error": null,
  "result": {
    "_id": "<profileId>",
    "_version": 1,
    "_source": {
      // new profile content
    }
    "created": true
  },
  "requestId": "<request unique identifier>",
  "controller": "security",
  "action": "createOrReplaceProfile"
}

Edit this page on Github