SDK Javascript v5.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.

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]) #

Arguments Type Description
options JSON Object Optional parameters
callback function Callback handling the response

Options #

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

Return Value #

Returns the Profile object to allow chaining.

Callback Response #

Returns a Profile object.

Usage #

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