SDK PHP v3.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!
use \Kuzzle\Kuzzle;
use \Kuzzle\Security\Role;
$roleId = 'myRole';
$kuzzle = new Kuzzle('localhost');
try {
  $role = $kuzzle->security()->fetchRole($roleId);
  // $role instanceof Role
catch (ErrorException $e) {