checkRights #

Checks if the provided API request can be executed by this client, using the current authentication information.

Future<bool> checkRights(
    Map<String, dynamic> requestPayload)

Map<String, dynamic>

requestPayload #

The RequestPayload must contain at least the following properties:

• controller: API controller
• action: API action

Returns #

Returns a boolean telling whether the provided request is allowed or not.

Usage #

final requestPayload = {
  'controller': 'document',
  'action': 'create',
  'index': 'nyc-open-data',
  'collection': 'yellow-taxi',
  'body': {
    'name': 'Melis'
  }
};
final result = await kuzzle
  .auth
  .checkRights(requestPayload);