getCredentialsById #

Gets credential information for the user identified by the strategy's unique user identifier userId.

The returned object will vary depending on the strategy (see getById plugin function), and can be empty.

Note: the user identifier to use depends on the specified strategy. If you wish to get credential information using a kuid identifier, use the getCredentials action instead.

getCredentialsById(strategy, id, [options]);

Property	Type	Description
`strategy`	string	Strategy identifier
`id`	string	Credential identifier (this is not the 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
`timeout`	number (`-1`)	Time (in ms) during which a request will still be waited to be resolved. Set it `-1` if you want to wait indefinitely
`triggerEvents`	boolean (`false`)	If set to `true`, will trigger events even if using Embeded SDK. You should always ensure that your events/pipes does not create an infinite loop. Available since Kuzzle 2.31.0

Resolves #

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

Usage #

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

Edit this page on Github