updateProfileMapping #

Updates the internal profile storage mapping.

Copied to clipboard!

updateProfileMapping(mapping, [options]);

Property	Type	Description
mapping	object	Profile collection mapping definition
options	object	Query options

options #

Property	Type (default)	Description
queuable	boolean (true)	If true, queues the request during downtime, until connected to Kuzzle again

Resolves #

Resolves an object representing the new mapping.

Usage #

Copied to clipboard!

try {
  const updatedMapping = await kuzzle.security.updateProfileMapping({
    properties: {
      description: { type: 'text' }
    }
  });
  console.log(updatedMapping);
  /*
    {
      properties: {
        description: { type: 'text' }
      }
    }
  */
} catch (e) {
  console.error(e);
}