getMyRights #

Returns the exhaustive list of granted or denied rights for the currently logged in user.

getMyRights([options]);

Arguments	Type	Description
`options`	object	Query options

options #

Additional query options

Property	Type (default)	Description
`queuable`	boolean (`true`)	Make this request queuable or not
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

An array containing user rights objects.

Each user right object has the following properties:

Property	Type	Description
`controller`	string	Controller on wich the rights are applied
`action`	string	Action on wich the rights are applied
`index`	string	Index on wich the rights are applied
`collection`	string	Collection on wich the rights are applied
`value`	string	Rights (`allowed`, `denied`, `conditional`)

Usage #

const credentials = { username: 'foo', password: 'bar' };
try {
  await kuzzle.auth.login('local', credentials);
  const rights = await kuzzle.auth.getMyRights();
  console.log(rights);
  /*
    [ { controller: '*',
      action: '*',
      collection: '*',
      index: '*',
      value: 'allowed' } ]
  */
  console.log('Success');
} catch (error) {
  console.error(error.message);
}

Edit this page on Github