createRole #

Create a new role in Kuzzle.

There is a small delay between role creation and its availability in our search layer (usually a couple of seconds). That means that a role that was just created may not be returned immediately by the searchRoles function.

createRole(id, content, [options], callback) #

Arguments	Type	Description
`id`	string	Unique role identifier
`content`	JSON Object	A plain JSON object representing the role
`options`	string	(Optional) Optional arguments
`callback`	function	Callback handling the response

Options #

Filter	Type	Description	Default
`replaceIfExist`	boolean	If the same role already exists: throw an error if sets to false. Replace the existing role otherwise	`false`
`queuable`	boolean	Make this request queuable or not	`true`
`refresh`	string	If set to `wait_for`, Kuzzle will wait the persistence layer to finish indexing (available with Elasticsearch 5.x and above)	`undefined`

Callback Response #

Returns a Role object.

Usage #

<?php
use \Kuzzle\Kuzzle;
use \Kuzzle\Security\Role;
$roleId = 'myRole';
$roleDefinition = [
  'controllers' => [
    '*' => [
      'actions' => [
        '*' => true
      ]
    ]
  ]
];
$kuzzle = new Kuzzle('localhost');
$security = $kuzzle->security();
try {
  $role = $security->createRole($roleId, $roleDefinition);
  // $role instanceof Role
}
catch (ErrorException $e) {
  // error occurred
}

Edit this page on Github