Core 2.x

getCredentials

Gets a user's credential information for the specified authentication strategy.


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

Property Type Description
strategy
string
Strategy identifier
kuid
string
User kuid
options
object
Query options

options

Additional query options

Property Type
(default)
Description
queuable
boolean

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

Resolves

An object containing the credential information (depends on the authentication strategy).

Usage

Copied to clipboard!
try {
  const response = await kuzzle.security.getCredentials('local', 'john.doe');
  console.log(response);
  /*
  { username: 'jdoe', kuid: 'john.doe' }
    */
} catch (e) {
  console.error(e);
}