authenticate - API Key Module Reference

This documentation provides a reference to the authenticate method. This belongs to the API Key Module.

This method verifies whether a token is valid, considering it authenticated.

Example

const apiKey =
  await apiKeyModuleService.authenticate("AbCD123987")

if (!apiKey) {
  // authentication failed
}

Parameters

tokenstringRequired

The token to verify.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<false | ApiKeyDTO>Required

If the token is verified successfully, the API key associated with the token is returned. Otherwise, false is returned.