Core 2.x

getUserMapping

Gets the mapping of the internal users collection.


Copied to clipboard!
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

Resolves

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

Usage

Copied to clipboard!
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);
}