SDK
SDK Javascript v7.x
2

# getRoleMapping

Gets the mapping of the internal security roles collection.


Copied to clipboard!
getRoleMapping([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 roles mapping, using Elasticsearch mapping format.

# Usage

Copied to clipboard!
try {
  const response = await kuzzle.security.getRoleMapping();
  console.log(response);
  /*
  { mapping: { controllers: { type: 'object', enabled: false } } }
    */
} catch (e) {
  console.error(e);
}