createUsersWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more users. It's used by other workflows, such as acceptInviteWorkflow to create a user for an invite.

You can attach an auth identity to each user to allow the user to log in using the setAuthAppMetadataStep. Learn more about auth identities in this documentation.

You can use this workflow within your customizations or your own custom workflows, allowing you to create users within your custom flows.

Source Code

Examples#

Steps#

createUsersStep

emitEventStep

Workflow hook

Step conditioned by when

View step details

Input#

CreateUsersWorkflowInputDTOCreateUsersWorkflowInputDTO

usersCreateUserDTO[]

The users to create.

Output#

UserDTO[]UserDTO[]

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.

Emitted 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
`user.created`	Emitted when users are created.	`[{ id, // The ID of the user }]`

Was this page helpful?