- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
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#
Workflow Hook
Step conditioned by when
Input#
CreateApiKeysWorkflowInputCreateApiKeysWorkflowInputThe data to create API keys.
CreateApiKeysWorkflowInputCreateApiKeysWorkflowInputapi_keysCreateApiKeyDTO[]The API keys to create.
api_keysCreateApiKeyDTO[]Output#
CreateApiKeysWorkflowOutputCreateApiKeysWorkflowOutputThe created API keys.
CreateApiKeysWorkflowOutputCreateApiKeysWorkflowOutputidstringThe 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 | DateWas this page helpful?