SDK PHP v3.x

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.

update #

Updates the role object in Kuzzle.

Unlike a regular document update, this method will replace the whole role definition under the indexes node with the updateContent parameter.

In other words, you always need to provide the complete role definition.

This method has the same effect as calling setContent followed by the save method.

To get more information about Kuzzle permissions, please refer to our permissions guide.

update(content, [options], [callback]) #

Arguments Type Description
content JSON Object New role content
options JSON Object Optional parameters
callback function Optional callback handling the response

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Return Value #

Returns the Role object to allow chaining.

Callback Response #

Returns the updated version of this object.

Usage #

Copied to clipboard!
use Kuzzle\Security\Role;
// ...
$roleDefinition = [
  'controllers' => [
    'document' => [
      'actions' => [
        'get' => true
  * @var $role Role
try {
  $role = $role->update($roleDefinition);
  // $role instanceof Role
catch (ErrorException $e) {
  // error occured