Dart Reference v2.0

Create a user

Creates a new user.

To confirm the user's email address or phone number, set email_confirm or phone_confirm to true. Both arguments default to false.
createUser() will not send a confirmation email to the user. You can use inviteUserByEmail() if you want to send them an email invite instead.
If you are sure that the created user's email or phone number is legitimate and verified, you can set the email_confirm or phone_confirm param to true.

Parameters

attributes

REQUIRED

AdminUserAttributes

Attributes to create the user with.

REQUIRED

String

The email address of the user.

password

REQUIRED

String

The password of the user.

phone

Optional

String

The phone number of the user.

userMetadata

Optional

Map<String, dynamic>

A custom data object to store the user's metadata. This maps to the `auth.users.user_metadata` column.

appMetadata

Optional

Map<String, dynamic>

A custom data object to store the user's application specific metadata. This maps to the `auth.users.app_metadata` column.

emailConfirm

Optional

bool

Whether to confirm the user's email address.

phoneConfirm

Optional

bool

Whether to confirm the user's phone number.

banDuration

Optional

String

Determines how long a user is banned for. Some possible durations include '300ms', '2h45m'.


final res = await supabase.auth.admin.createUser(AdminUserAttributes(
  email: '[email protected]',
  password: 'password',
  userMetadata: {'name': 'Yoda'},
));

Response