createUserAccountWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createUserAccountWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates a user and attaches it to an auth identity.
You can create an auth identity first using the Retrieve Registration JWT Token API Route. Learn more about basic authentication flows in this documentation.
You can use this workflow within your customizations or your own custom workflows, allowing you to register or create user accounts within your custom flows.
Source CodeExamples#
Steps#
Input#
CreateUserAccountWorkflowInputCreateUserAccountWorkflowInputThe details of the user account to create.
CreateUserAccountWorkflowInputCreateUserAccountWorkflowInputauthIdentityIdstringThe ID of the auth identity to attach the user to.
authIdentityIdstringuserDataCreateUserDTOThe details of the user to create.
userDataCreateUserDTOOutput#
UserDTOUserDTOThe user details.
UserDTOUserDTOidstringThe ID of the user.
idstringemailstringThe email of the user.
emailstringfirst_namenull | stringThe first name of the user.
first_namenull | stringlast_namenull | stringThe last name of the user.
last_namenull | stringavatar_urlnull | stringThe avatar URL of the user.
avatar_urlnull | stringmetadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>created_atDateThe creation date of the user.
created_atDateupdated_atDateThe updated date of the user.
updated_atDatedeleted_atnull | DateThe deletion date of the user.
deleted_atnull | DateEmitted Events#
This section lists the events that are either triggered by the emitEventStep in the workflow, or by another workflow executed within this workflow.
You can listen to these events in a subscriber, as explained in the Subscribers documentation.
Event | Description | Payload | Action |
|---|---|---|---|
| Emitted when users are created. |
|