getMyRights #

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

Copied to clipboard!

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

Resolves #

An object[] containing:

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 #

Copied to clipboard!

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