updateUserMapping #

Updates the internal user storage mapping.

Copied to clipboard!

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 #

Resolves an object representing the new mapping.

Usage #

Copied to clipboard!

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