updateApiKeysWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the updateApiKeysWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow updates one or more secret or publishable API keys. It's used by the Update API Key Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to update API keys within your custom flows.

Examples#

updateApiKeysStep

Workflow Hook

Step conditioned by when

UpdateApiKeysWorkflowInputUpdateApiKeysWorkflowInput

The data to update API keys.

The filters to select the API keys to update.

The data to update the API keys.

UpdateApiKeysWorkflowOutputUpdateApiKeysWorkflowOutput

The updated API keys.

idstring

The ID of the API key.

tokenstring

The token of the API key.

redactedstring

The redacted form of the API key's token. This is useful when showing portion of the token. For example sk_...123.

titlestring

The title of the API key.

The type of the API key.

last_used_atnull | Date

The date the API key was last used.

created_bystring

Who created the API key.

created_atDate

The date the API key was created.

updated_atDate

The date the API key was updated.

deleted_atnull | Date

The date the API key was deleted.

revoked_bynull | string

Who revoked the API key. For example, the ID of the user that revoked it.

revoked_atnull | Date

The date the API key was revoked.

Was this page helpful?