updateProfile #

Performs a partial update on an existing profile.

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

Arguments	Type	Description
`id`	string	Unique role identifier
`policies`	array of objects	List of policies to apply to this profile
`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 #

Return an updated Profile object.

Usage #

var policies = [
  {roleId: 'myrole'},
  {
    roleId: 'default', 
    restrictedTo: [
      {index: 'index1'}, 
      {index: 'index2', collections: ['foo', 'bar'] } 
    ] 
  }
];
// Using callbacks (NodeJS or Web Browser)
kuzzle
  .security
  .updateProfile("profile ID", policies, function (err, updatedProfile) {
  });
// Using promises (NodeJS)
kuzzle
  .security
  .updateProfilePromise("profile ID", policies)
  .then(updatedProfile => {
  });

Edit this page on Github