JavaScript: Sign in a user through SSO

Attempts a single-sign on using an enterprise Identity Provider. A successful SSO attempt will redirect the current page to the identity provider authorization page. The redirect URL is implementation and SSO protocol specific.

• Before you can call this method you need to establish a connection to an identity provider. Use the CLI commands to do this.
• If you've associated an email domain to the identity provider, you can use the domain property to start a sign-in flow.
• In case you need to use a different way to start the authentication flow with an identity provider, you can use the providerId property. For example:
  • Mapping specific user email addresses with an identity provider.
  • Using different hints to identity the identity provider to be used by the user, like a company-specific page, IP address or other tracking information.

Parameters

• params

  (Required)

Examples

Sign in with email domain

  // You can extract the user's email domain and use it to trigger the
  // authentication flow with the correct identity provider.

  const \{ data, error \} = await supabase.auth.signInWithSSO(\{
    domain: 'company.com'
  \})

  if (data?.url) \{
    // redirect the user to the identity provider's authentication flow
    window.location.href = data.url
  \}

Sign in with provider UUID

  // Useful when you need to map a user's sign in request according
  // to different rules that can't use email domains.

  const \{ data, error \} = await supabase.auth.signInWithSSO(\{
    providerId: '21648a9d-8d5a-4555-a9d1-d6375dc14e92'
  \})

  if (data?.url) \{
    // redirect the user to the identity provider's authentication flow
    window.location.href = data.url
  \}