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.

scrollProfiles #

Scrolls on stored profiles using the provided scroll ID.


scrollProfiles(scrollId, [options], callback) #

ArgumentsTypeDescription
scrollIdstringScroll identifier retrieved from a search query
optionsJSON ObjectOptional parameters
callbackfunctionCallback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

Returns the list of fetched security profiles according to the scroll parameters (offset, limit etc.).

Usage #

// Using callbacks (NodeJS or Web Browser)
kuzzle
  .security
  .scrollProfiles(scrollId, options, function(error, result) {
    // called once the scroll action has been completed
  });