createCredentials

Creates authentication credentials for a user.


Copied to clipboard!
createCredentials(strategy, kuid, credentials, [options]);

Property Type Description
strategy
string
Strategy to use
kuid
string
User kuid
credentials
object
New credentials
options
object
Query options

credentials

The credentials to send. The expected properties depend on the target authentication strategy.

Example for the local strategy:

Copied to clipboard!
{
  username: 'foo',
  password: 'bar'
}

options

Additional query options

Property Type
(default)
Description
queuable
boolean

(true)
If true, queues the request during downtime, until connected to Kuzzle again
refresh
boolean

(false)
If set to wait_for, Kuzzle will not respond until the credentials are indexed

Resolves

An object representing the new credentials.
The content depends on the authentication strategy.

Usage

Copied to clipboard!
try {
  await kuzzle.security.createUser('foo', {
    content: {
      profileIds: ['default'],
      fullName: 'John Doe'
    },
    credentials: {}
  });

  const response = await kuzzle.security.createCredentials(
    'local',
    'foo',
    { username: 'foo', password: 'bar' }
  );
  console.log(response);
  /*
    { username: 'foo' }
  */

  console.log('Credentials successfully created');
} catch (e) {
  console.error(e);
}