updateUserMapping #

Updates the internal user storage mapping.

updateUserMapping(mapping, [options]);

Property	Type	Description
`mapping`	object	User 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 #

try {
  const response = await kuzzle.security.updateUserMapping({
    properties: {
      firstName: { type: 'text' },
      lastName: { type: 'text' },
      birthDate: {
        type: 'date',
        format: 'yyyy-mm-dd'
      }
    }
  });
  console.log(response);
  /*
  { acknowledged: true }
    */
} catch (e) {
  console.error(e);
}

Edit this page on Github