SDK
SDK PHP v3.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.

updateCredentials #

Update the current user's credentials for the specified <strategy>. The credentials to send depend on the authentication plugin and the strategy.


updateCredentials(strategy, kuid, credentials, [options], [callback]) #

ArgumentsTypeDescription
strategystringStrategy you want to create credentials in
kuidJSON objectUser's kuid
credentialsJSON objectThe credentials
optionsJSON objectOptional parameters
callbackfunctionOptional callback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

Returns an object with the updated credentials.

Usage #

<?phpfound
use \Kuzzle\Kuzzle;
$kuzzle = new Kuzzle('localhost');
$updatedCredentials = $kuzzle->security->updateCredentials('local', 'kuid', ['username' => 'foo']);

Callback response

{
  "username": "foo",
  "kuid": "<Kuzzle Unique User Identifier>"
}