deleteRole #

Deletes a security role.

deleteRole(id, [options]);

Property	Type	Description
`id`	string	Role identifier
`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
`refresh`	boolean (`false`)	If set to `wait_for`, Kuzzle will not respond until the role deletion is indexed
`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 acknowledgment message.

Usage #

try {
  const response = await kuzzle.security.deleteRole('myRole');
  console.log(response);
  /*
  { found: true,
    _index: '%kuzzle',
    _type; 'roles',
    _id: 'myRole',,
    _version: 2,
    result: 'deleted',
    _shards: {  total: 2, successful: 1, failed: 0 } }
   */
  console.log('Role successfully deleted');
} catch (e) {
  console.error(e);
}

Edit this page on Github