Swift: Create 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, a user is returned but session is null.
  • If Confirm email is disabled, both a user and a session are returned.
• 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.
• If signUp() 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.
• To fetch the currently logged-in user, refer to getUser().

Parameters

• email

  (Optional)

  One of `email` or `phone` must be provided.

• phone

  (Optional)

  One of `email` or `phone` must be provided.

• password

  (Required)

  undefined

• data

  (Optional)

  A custom data object to store additional user metadata.

• redirectTo

  (Optional)

  Only for email signups. The redirect URL embedded in the email link. Must be a configured redirect URL for your Supabase instance.

• captchaToken

  (Optional)

  undefined

Examples

Sign up with email and password

try await supabase.auth.signUp(
  email: "example@email.com",
  password: "example-password"
)

Sign up with a phone number and password (SMS)

try await supabase.auth.signUp(
  phone: "123456789",
  password: "example-password",
  channel: "sms"
)

Sign up with a phone number and password (whatsapp)

try await supabase.auth.signUp(
  phone: "123456789",
  password: "example-password",
  channel: "whatsapp"
)

Sign up with additional user metadata

try await supabase.auth.signUp(
  email: "example@email.com",
  password: "example-password",
  data: [
    "first_name": .string("John"),
    "age": .number(24)
  ]
)

Sign up with a redirect URL

try await supabase.auth.signUp(
  email:  "example@email.com",
  password: "example-password",
  redirectTo: URL(string: "https://example.com/welcome")!
)