SDK
SDK Javascript v5.x
1

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.

save #

Creates or replaces the profile in Kuzzle.

Saving the object will return an error if the linked roles have not been previously created in Kuzzle.

save([options], [callback]) #

ArgumentsTypeDescription
optionsJSON ObjectOptional parameters
callbackfunctionCallback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Return Value #

Returns the Profile object to allow chaining.


Callback Response #

Returns a Profile object.

Usage #

var profileDefinition = {
  policies: [
    {roleId: 'myrole'},
    {roleId: 'default', restrictedTo: [{index: 'index1'}, {index: 'index2', collections: ['foo', 'bar'] } ] }
  ]
};
var profile = kuzzle.security.profile('myprofile', profileDefinition);
// Using callbacks (NodeJS or Web Browser)
profile
  .save(function(error, result) {
    // result is a Profile object
  });
// Using promises (NodeJS)
profile
  .savePromise()
  .then(result => {
    // result is a Profile object
  });