createUsersStep - Medusa Core Workflows Reference

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

This step creates one or more users. To allow these users to log in, you must attach an auth identity to each user using the setAuthAppMetadataStep.

Example#

Code
1const data = createUsersStep([2  {3    email: "example@gmail.com",4    first_name: "John",5    last_name: "Doe",6  }7])

CreateUserDTO[]CreateUserDTO[]

emailstring

The email of the user.

first_namenull | stringOptional

The first name of the user.

last_namenull | stringOptional

The last name of the user.

avatar_urlnull | stringOptional

The avatar URL of the user.

metadatanull | Record<string, unknown>Optional

Holds custom data in key-value pairs.

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.

Was this page helpful?