Get Started
Product
Resources
Tools & SDKs
Framework
Reference

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 Code

Examples#

Steps#

createUsersWorkflow

setAuthAppMetadataStep

Workflow Hook

Step conditioned by when

Input#

CreateUserAccountWorkflowInputCreateUserAccountWorkflowInput

The details of the user account to create.

authIdentityIdstring

The ID of the auth identity to attach the user to.

userDataCreateUserDTO

The details of the user to create.

Output#

UserDTOUserDTO

The user details.

idstring

The ID of the user.

emailstring

The email of the user.

first_namenull | string

The first name of the user.

last_namenull | string

The last name of the user.

avatar_urlnull | string

The avatar URL of the user.

metadatanull | Record<string, unknown>

Holds custom data in key-value pairs.

created_atDate

The creation date of the user.

updated_atDate

The updated date of the user.

deleted_atnull | Date

The deletion date of the user.

Was this page helpful?