updateRoleMapping

Updates the internal role storage mapping.


Copied to clipboard!
updateRoleMapping(mapping, [options]);

Property Type Description
mapping
object
Role 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

An acknowledgment message.

Usage

Copied to clipboard!
try {
  const response = await kuzzle.security.updateRoleMapping({
    properties: {
      description: { type: 'text' }
    }
  });

  console.log(response);
  /*
  { acknowledged: true }
    */
} catch (e) {
  console.error(e);
}