SDK
SDK Javascript v6.x
1

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 #

An acknowledgment message.

Usage #

Copied to clipboard!
try {
  const response = await kuzzle.security.updateProfileMapping({
    properties: {
      description: { type: 'text' }
    }
  });
  console.log(response);
  /*
  { acknowledged: true }
    */
} catch (e) {
  console.error(e);
}