メインコンテンツまでスキップ

signUp()

Creates a new user.

const { user, session, error } = await supabase.auth.signUp({
  email: 'example@email.com',
  password: 'example-password',
})

Parameters​

  • __namedParametersrequiredUserCredentials

    No description provided.

  • optionsrequiredobject

    No description provided.

      Properties

    • captchaTokenoptionalstring

      No description provided.

    • dataoptionalobject

      No description provided.

    • redirectTooptionalstring

      No description provided.

Notes​

  • デフォルトでは、ユーザーはログインする前にメールアドレスを確認する必要があります。これを変更したい場合は、app.supabase.comの「Authentication」→「Settings」にアクセスします。「Email enable confirmations（Eメールによる確認を有効化）」を無効にします。
  • 「Email enable confirmations」を有効にすると、userが返されますが、sessionはnullになります。
  • 「Email Confirmations」を無効にすると、userとsessionの両方が返されます。
  • ユーザーがメールアドレスを確認すると、デフォルトではlocalhost:3000にリダイレクトされます。これを変更するには、app.supabase.comの「Authentication」→「Settings」で変更できます。
  • 確認済みの既存のユーザーに対してsignUp()が呼び出された場合は次のようになります。
    • もし、「Authentication」→「Settings」ページの「Enable email confirmations」が有効の場合、曖昧な偽のユーザー・オブジェクトを返します。
    • 「Enable email confirmations」を無効にした場合、「ユーザーがすでに登録されています」という内容のエラーが返ってきます。
  • ユーザーがすでに存在しているかどうかを確認するには、getUser()で確認してください。

Examples​

サインアップ​

const { user, session, error } = await supabase.auth.signUp({
  email: 'example@email.com',
  password: 'example-password',
})

ユーザーのメタデータを追加してサインアップ​

const { user, session, error } = await supabase.auth.signUp(
  {
    email: 'example@email.com',
    password: 'example-password',
  },
  {
    data: { 
      first_name: 'John', 
      age: 27,
    }
  }
)

サードパーティのプロバイダーでサインアップ​

OAuthプロバイダーにサインアップするには、signIn()メソッドを使用します。

電話番号によるサインアップ​

Supabaseは電話番号による認証に対応しています。ユーザーが自分の電話番号を確認した後、signIn()メソッドを使用することができます。

const { user, session, error } = await supabase.auth.signUp({
  phone: '+13334445555',
  password: 'some-password',
})

// After receiving an SMS with One Time Password.
let { session, error } = await supabase.auth.verifyOTP({
  phone: '+13334445555',
  token: '123456',
})