SDK
SDK Javascript v5.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

getMyRights #

Gets the rights for the current user.


getMyRights([options], callback) #

ArgumentsTypeDescription
optionsJSON ObjectOptional parameters
callbackfunctionCallback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

Returns an array of rights.

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle
  .getMyRights(function(error, rights) {
    // result is an array of objects
  });
// Using promises (NodeJS)
kuzzle
  .getMyRightsPromise()
  .then(rights => {
    // result is an array of objects
  });

Callback response

[
  {
    "controller": "my-controller",
    "action": "my-action",
    "index": "*",
    "collection": "*",
    "value": "allowed"
  },
  {
    "controller": "another-controller",
    "action": "*",
    "index": "my-index",
    "collection": "*",
    "value": "conditional"
  }
]