deleteApiKeys - API Key Module Reference

This documentation provides a reference to the deleteApiKeys 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.

deleteApiKeys(ids, sharedContext?): Promise<void>#

This method deletes API keys by their IDs.

Code
await apiKeyModuleService.deleteApiKeys(["apk_123"])

idsstring[]

The IDs of the API keys.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the API keys are deleted successfully.

This method deletes an API key by its ID.

Code
await apiKeyModuleService.deleteApiKeys("apk_123")

idstring

The ID of the API key.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the API key is deleted successfully.

Was this page helpful?