revoke - API Key Module Reference
This documentation provides a reference to the revoke
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.
revoke(selector, data, sharedContext?): Promise<ApiKeyDTO[]>#
This method revokes API keys based on the filters provided.
Example#
1const apiKey = await apiKeyModuleService.revoke(2 {3 id: "apk_123",4 },5 {6 revoked_by: "user_123",7 8 revoke_in: 60,9 }10)
Parameters#
The filters to specify which API keys should be revoked.
The details of revoking the API keys.
A context used to share resources, such as transaction manager, between the application and the module.
Returns#
revoke(id, data, sharedContext?): Promise<ApiKeyDTO>#
This method revokes an API key based on the ID provided.
Example#
1const apiKey = await apiKeyModuleService.revoke("apk_123", {2 revoked_by: "user_123",3 4 revoke_in: 60,5})
Parameters#
The ID of the API key to revoke.
The details of revoking the API key.
A context used to share resources, such as transaction manager, between the application and the module.
Returns#
Was this page helpful?