upsertApiKeys - API Key Module Reference

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

upsertApiKeys(data, sharedContext?): Promise<ApiKeyDTO[]>#

This method updates or creates API keys if they don't exist.

Example#

Code
1const apiKey = await apiKeyModuleService.upsertApiKeys([2  {3    id: "apk_123",4    title: "My development key",5  },6  {7    title: "New development key",8    type: "secret",9    created_by: "user_123",10  },11])

Parameters#

dataUpsertApiKeyDTO[]

The attributes in the API keys that are created or updated.

sharedContextContextOptional

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

Returns#

PromisePromise<ApiKeyDTO[]>

The created or updated API keys.

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

This method updates or creates an API key if it doesn't exist.

Example#

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

Parameters#

dataUpsertApiKeyDTO

The attributes in the API key that's created or updated.

sharedContextContextOptional

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

Returns#

PromisePromise<ApiKeyDTO>

The created or updated API key.

Was this page helpful?