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.

updateProfile #

Performs a partial update on an existing profile.

updateProfile(id, content, [options], [callback]) #

Arguments Type Description
id string Unique role identifier
policies array of objects List of policies to apply to this profile
options string (Optional) Optional arguments
callback function (Optional) Callback handling the response

Options #

Filter Type Description Default
queuable boolean Make this request queuable or not true
refresh string If set to wait_for, Kuzzle will wait for the persistence layer to finish indexing (available with Elasticsearch 5.x and above) undefined

Return Value #

Returns the Security object to allow chaining.

Callback Response #

Return an updated Profile object.

Usage #

Copied to clipboard!
use \Kuzzle\Kuzzle;
use \Kuzzle\Security\Profile;
$profileId = 'myProfile';
$policies = [
    'roleId' => 'myRole'
    'roleId' => 'anonymous',
    'restrictedTo' => [
      ['index' => 'my-second-index', 'collection' => ['my-collection']]
$kuzzle = new Kuzzle('localhost');
$security = $kuzzle->security();
try {
  $profile = $security->updateProfile($profileId, $policies);
  // $profile instanceof Profile
catch (ErrorException $e) {