mDeleteProfiles #

Deletes multiple security profiles.

Throws a partial error (error code 206) if one or more profile deletions fail.

mDeleteProfiles(ids, [options]);

Property	Type	Description
`ids`	array<string>	Profile identifiers
`options`	object	Query options

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 profiles 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 array of the deleted profile ids.

Usage #

try {
  const response = await kuzzle.security.mDeleteProfiles([
    'profile1',
    'profile2',
    'profile3',
    'profile4',
    'profile5'
  ]);
  console.log(response);
  /*
  [ 'profile1', 'profile2', 'profile3', 'profile4', 'profile5' ]
    */
} catch (e) {
  console.error(e);
}

Edit this page on Github