getProfileMapping #

Gets the mapping of the internal security profiles collection.

getProfileMapping([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 profiles mapping, using Elasticsearch mapping format.

Usage #

try {
  const response = await kuzzle.security.getProfileMapping();
  console.log(response);
  /*
  { mapping:
    { policies:
      { properties:
        { restrictedTo:
          { properties:
            { collections:
              { type: 'text',
                fields: { keyword: { type: 'keyword', ignore_above: 256 } } },
              index:
              { type: 'text',
                fields: { keyword: { type: 'keyword', ignore_above: 256 } } } } },
          roleId: { type: 'keyword' } } } } }
   */
} catch (e) {
  console.error(e);
}

Edit this page on Github