checkToken #

Checks a token validity.

If no token is provided, the SDK checks its internal authentication token.

checkToken([token]);

Property	Type	Description
`token`	string	Optional authentication token
`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 representing the token validity status

Name	Type	Description
`valid`	boolean	Tell if the token is valid or not
`state`	string	Explain why the token is invalid
`expiresAt`	number	Token expiration timestamp

Usage #

const credentials = { username: 'foo', password: 'bar' };
try {
  const jwt = await kuzzle.auth.login('local', credentials);
  // Check the internal jwt validity
  await kuzzle.auth.checkToken();
  // Check the jwt validity
  const result = await kuzzle.auth.checkToken(jwt);
  console.log(result);
  /*
    { valid: true, expiresAt: 1540824822897 }
  */
  if (result.valid) {
    console.log('Token is valid');
  } else {
    console.error(`Token is invalid: ${result.state}`);
  }
} catch (error) {
  console.error(error.message);
}

Edit this page on Github