authenticate - API Key Module Reference

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

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

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

Example#

Code
1const apiKey =2  await apiKeyModuleService.authenticate("AbCD123987")3
4if (!apiKey) {5  // authentication failed6}

tokenstring

The token to verify.

sharedContextContextOptional

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

PromisePromise<false | ApiKeyDTO>

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

Was this page helpful?