Loading...
Was this page helpful?
Loading...
createApiKeysWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createApiKeysWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates one or more API keys, which can be secret or publishable. It's used by the Create API Key Admin API Route.
You can use this workflow within your customizations or your own custom workflows, allowing you to create API keys within your custom flows.
Source CodeExamples#
Steps#
Input#
CreateApiKeysWorkflowInputCreateApiKeysWorkflowInputThe data to create API keys.
CreateApiKeysWorkflowInputCreateApiKeysWorkflowInputapi_keysCreateApiKeyDTO[]The API keys to create.
api_keysCreateApiKeyDTO[]Output#
ApiKeyDTO[]ApiKeyDTO[]
ApiKeyDTO[]ApiKeyDTO[]idstringThe ID of the API key.
idstringtokenstringThe token of the API key.
tokenstringredactedstringThe redacted form of the API key's token. This is useful
when showing portion of the token. For example sk_...123.
redactedstringsk_...123.titlestringThe title of the API key.
titlestringtypeApiKeyTypeThe type of the API key.
typeApiKeyTypelast_used_atnull | DateThe date the API key was last used.
last_used_atnull | Datecreated_bystringWho created the API key.
created_bystringcreated_atDateThe date the API key was created.
created_atDateupdated_atDateThe date the API key was updated.
updated_atDatedeleted_atnull | DateThe date the API key was deleted.
deleted_atnull | Daterevoked_bynull | stringWho revoked the API key. For example,
the ID of the user that revoked it.
revoked_bynull | stringrevoked_atnull | DateThe date the API key was revoked.
revoked_atnull | DateHooks#
Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.
Learn more about Hooks and Additional Data.
apiKeysCreated#
This step is a hook that you can inject custom functionality into.
Example
Input
Handlers consuming this hook accept the following input.