Unknown SDK

getUserRights

Gets the detailed rights granted to a user.


Copied to clipboard!
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

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

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