getUserMapping #

Gets the mapping of the internal users collection.

getUserMapping([options]);

Property	Type	Description
`options`	object	Query options

options #

Additional query options

Property	Type (default)	Description
`queuable`	boolean (`true`)	If `true`, queues the request during downtime, until connected to Kuzzle again
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

An object representing the internal users mapping, using Elasticsearch mapping format.

Usage #

try {
  const response = await kuzzle.security.getUserMapping();
  console.log(response);
  /*
  { mapping:
    { firstname:
      { type: 'text',
        fields: { keyword: { type: 'keyword', ignore_above: 256 } } },
      lastname:
        { type: 'text',
          fields: { keyword: { type: 'keyword', ignore_above: 256 } } },
      profileIds: { type: 'keyword' } } }
   */
} catch (e) {
  console.error(e);
}