You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

createRole #

Creates a new role.

Query Syntax #

HTTP #

URL: http://kuzzle:7512/roles/<_id>/_create[?refresh=wait_for]
Method: POST
Body:

{
  "controllers": {
    "*": {
      "actions": {
        "*": true
      }
    }
  }
}

Other protocols #

{
  "controller": "security",
  "action": "createRole",
  "_id": "<roleId>",
  "body": {
    "controllers": {
      "*": {
        "actions": {
          "*": true
        }
      }
    }
  }
}

Arguments #

_id: role identifier

Optional: #

refresh: if set to wait_for, Kuzzle will not respond until the created role is indexed

Body properties #

controllers: role definition

Response #

Returns the role creation/replacement status:

_id: created/replaced role identifier
_source: role definition
created: always true
version: always 1

{
  "status": 200,
  "error": null,
  "result": {
    "_id": "<roleId>",
    "_version": 1,
    "created": true,
    "_source": {
      "controllers": {
        "*": {
          "actions": {
            "*": true
          }
        }
      }
    }
  }
  "requestId": "<unique request identifier>",
  "controller": "security",
  "action": "createRole"
}