SDK
SDK Javascript v7.x
2

mGetRoles #

Gets multiple security roles.


mGetRoles(ids, [options]);

PropertyTypeDescription
ids
array<string>
Roles identifiers
options
object
Query options

options #

PropertyType
(default)
Description
queuable
boolean

(true)
If true, queues the request during downtime, until connected to Kuzzle again
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 retrieved Role objects.

Usage #

try {
  const response = await kuzzle.security.mGetRoles([
    'role1',
    'role2',
    'role3'
  ]);
  console.log(response);
  /*
  [ Role {
      _id: 'role1',
      controllers: { '*': [Object] } },
    Role {
      _id: 'role2',
      controllers: { '*': [Object] } },
    Role {
      _id: 'role3',
      controllers: { '*': [Object] } } ]
   */
} catch (e) {
  console.error(e);
}