getUserRights #

Gets the detailed rights granted to a user.

getUserRights(kui, [options]);

Property	Type	Description
`kuid`	string	User kuid
`options`	object	Query options

options #

Property	Type (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 objects. Each object is a security right granted or denied to the user:

controller: impacted controller
action: impacted controller action
index: index name
collection: collection name
value: tell if access if allowed or denied. If closures have been configured on the detailed scope, the value is conditional.

Usage #

try {
  const response = await kuzzle.security.getUserRights('john.doe');
  console.log(response);
  /*
  [ { controller: '*',
    action: '*',
    index: '*',
    collection: '*',
    value: 'allowed' } ]
   */
} catch (e) {
  console.error(e);
}

Edit this page on Github