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 CodeCreateUsersWorkflowInputDTO
CreateUsersWorkflowInputDTOusers
CreateUserDTO[]UserDTO[]
UserDTO[]id
stringemail
stringfirst_name
null | stringlast_name
null | stringavatar_url
null | stringmetadata
null | Record<string, unknown>created_at
Dateupdated_at
Datedeleted_at
null | DateThis 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. |
|