Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.04 KB

File metadata and controls

44 lines (30 loc) · 1.04 KB
code type title description
true
page
getUserRights
Gets the detailed rights granted to a user

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

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

<<< ./snippets/get-user-rights.js