retrieveApiKey - API Key Module Reference

This documentation provides a reference to the retrieveApiKey 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 retrieves an API key by its ID.

Example#

Code
const apiKey = await apiKeyModuleService.retrieveApiKey("apk_123")

Parameters#

idstring

The ID of the API key.

configFindConfig<ApiKeyDTO>Optional

The configurations determining how the API key is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a api key.

sharedContextContextOptional

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

Returns#

PromisePromise<ApiKeyDTO>

The retrieved API key.

Was this page helpful?