updateApiKeys - API Key Module Reference

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

updateApiKeys(id, data, sharedContext?): Promise<ApiKeyDTO>#

This method updates an existing API key.

Code
1const apiKey = await apiKeyModuleService.updateApiKeys("apk_123", {2  title: "My development key"3})

idstring

The ID of the API key.

The attributes to update in the API key.

sharedContextContextOptional

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

PromisePromise<ApiKeyDTO>

The updated API key.

This method updates existing API keys.

Code
1const apiKey = await apiKeyModuleService.updateApiKeys(2  {3    title: "Development key",4  },5  {6    title: "My development key",7  }8)

The filters that specify which API keys should be updated.

The attributes to update in the API keys.

sharedContextContextOptional

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

PromisePromise<ApiKeyDTO[]>

The updated API keys.

Was this page helpful?