SDK
SDK Javascript v7.x
2

checkRights #

Available since Kuzzle 2.8.0
Available since 7.5.0

Checks if the provided API request can be executed by the current logged user.


Copied to clipboard!
checkRights(requestPayload)
Property Type Description
requestPayload
object
Contains a RequestPayload

requestPayload #

The RequestPayload must contains at least the following properties:

  • controller: API controller
  • action: API action

Resolves #

A boolean telling whether the provided request would have been allowed or not.

Usage #

Copied to clipboard!
const requestPayload = {
  controller: 'document',
  action: 'create',
  index: 'nyc-open-data',
  collection: 'yellow-taxi',
  body: {
    name: 'Melis'
  }
}
try {
  const result = await kuzzle.auth.checkRights(requestPayload);
  console.log(result);
  /*
    true
  */
} catch (error) {
  console.error(error.message);
}