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 controlleraction
: impacted controller actionindex
: index namecollection
: collection namevalue
: tell if access ifallowed
ordenied
. If closures have been configured on the detailed scope, the value isconditional
.
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 (opens new window)