SDK Javascript v5.x

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.

fetchRole #

Fetches a single stored role using its unique ID.

fetchRole(id, [options], callback) #

Arguments Type Description
id string Unique role identifier
options JSON Object Optional parameters
callback function Callback handling the response

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Callback Response #

Returns a Role object.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
  .fetchRole('myrole', function(error, result) {
    // result is a Role object
// Using promises (NodeJS)
  .then((result) => {
    // result is a Role object