getProfileRights #

Gets the detailed rights configured by a security profile

string

object

options #

Additional query options

boolean

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 #

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);
}