Javascript 7.x

getProfileRights

Gets the detailed rights configured by a security profile


```js getProfileRights(id, [options]); ```
Property Type Description
id
string
Profile identifier
options
object
Query options

options

Additional query 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 described by the security profile:

  • controller: impacted controller
  • action: impacted controller action
  • index: index name
  • collection: collection name
  • value: tells 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.getProfileRights('myProfile');
  console.log(response);
  /*
  [ { controller: 'auth',
      action: 'login',
      index: '*',
      collection: '*',
      value: 'allowed'
    },
    { controller: 'document',
      action: 'get',
      index: 'someIndex',
      collection: '*',
      value: 'allowed'
    } [..]
  ]
  */
} catch (e) {
  console.error(e);
}