SDK
SDK Javascript v6.x
1

checkToken #

Checks a token validity.

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


Copied to clipboard!
checkToken([token]);

Property Type Description
token
string
Optional authentication token

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
expires_at
number
Token expiration timestamp

Usage #

Copied to clipboard!
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);
}