Kotlin: Create a new user

Creates a new user.

• By default, the user needs to verify their email address before logging in. To turn this off, disable Confirm email in your project.
• Confirm email determines if users need to confirm their email address after signing up.
  • If Confirm email is enabled, the return value is the user and you won't be logged in automatically.
  • If Confirm email is disabled, the return value is null and you will be logged in instead.
• When the user confirms their email address, they are redirected to the SITE_URL by default. You can modify your SITE_URL or add additional redirect URLs in your project.
• To learn how to handle OTP links & OAuth refer to initializing
• If signUpWith() is called for an existing confirmed user:
  • When both Confirm email and Confirm phone (even when phone provider is disabled) are enabled in your project, an obfuscated/fake user object is returned.
  • When either Confirm email or Confirm phone (even when phone provider is disabled) is disabled, the error message, User already registered is returned.

Parameters

• provider

  (Required)

  The provider to use for the user's authentication. In this case `Email` or `Phone`.

• redirectUrl

  (Optional)

  The redirect url to use. If you don't specify this, the platform specific will be used, like deeplinks on android.

• config

  (Optional)

  The configuration for signing in with `Email` or `Phone`.

Examples

Sign up with email

val user = supabase.auth.signUpWith(Email) \{
    email = "example@email.com"
    password = "example-password"
\}

Sign up with a phone number and password (whatsapp)

val user = supabase.auth.signUpWith(Phone) \{
    phone = "+4912345679"
    password = "example-password"
    channel = Phone.Channel.WHATSAPP
\}

Sign up with a phone number and password (sms)

val user = supabase.auth.signUpWith(Phone) \{
    phone = "+4912345679"
    password = "example-password"
\}

Sign up with additional user metadata

val user = supabase.auth.signUpWith(Email) \{
    email = "example@email.com"
    password = "example-password"
    data = buildJsonObject \{
       put("first_name", "John")
       put("age", 24)
    \}
\}

Sign up with a redirect URL

val user = supabase.auth.signUpWith(Email, redirectUrl = "https://example.com") \{
    email = "example@email.com"
    password = "example-password"
\}