updateRole #

Performs a partial update on an existing role.

updateRole(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	(Optional) Callback handling the response

Options #

Filter	Type	Description	Default
`queuable`	boolean	Make this request queuable or not	`true`
`refresh`	string	If set to `wait_for`, Kuzzle will wait for the persistence layer to finish indexing (available with Elasticsearch 5.x and above)	`undefined`

Return Value #

Returns the Security object to allow chaining.

Callback Response #

Returns an updated Role object.

Usage #

var roleDefinition = {
  controllers: {
    "read": {
      actions: {
        "get": true
      }
    }
  }
};
// Using callbacks (NodeJS or Web Browser)
kuzzle
  .security
  .updateRole("role ID", roleDefinition, function (err, updatedRole) {
    // "updatedRole" is an instance of a Role object
  });
// Using promises (NodeJS)
kuzzle
  .security
  .updateRolePromise("profile ID", roleDefinition)
  .then(updatedRole => {
    // "updatedRole" is an instance of a Role object
  });

Edit this page on Github