AuthenticateWith
These are all methods on the SignUp
class that allow you to authenticate with different methods.
authenticateWithRedirect()
Signs up users via OAuth, where an external account provider is used to verify the user's identity and provide certain information about the user.
- Name
redirectUrl
- Type
string
- Description
The full URL or path that the OAuth provider should redirect to after successful authorization on their part. Typically, this will be a simple
/sso-callback
route that either callsClerk.handleRedirectCallback
or mounts the<AuthenticateWithRedirectCallback />
component. See the custom flow for implementation details.
- Name
redirectUrlComplete
- Type
string
- Description
Full URL or path to navigate after the OAuth or SAML flow completes.
- Name
continueSignUp
- Type
boolean | undefined
- Description
- Name
strategy
- Type
'oauth_<provider>' | 'saml' | 'enterprise_sso'
- Description
The strategy to use for authentication. The following strategies are supported:
'oauth_<provider>'
: The user will be authenticated with their social connection account. See a list of supported values for<provider>
.'saml'
(deprecated): Deprecated in favor of'enterprise_sso'
. The user will be authenticated with their SAML account.'enterprise_sso'
: The user will be authenticated either through SAML or OIDC depending on the configuration of their enterprise SSO account.
- Name
identifier
- Type
string | undefined
- Description
Identifier to use for targeting an enterprise connection at sign-up.
- Name
emailAddress
- Type
string | undefined
- Description
Email address to use for targeting an enterprise connection at sign-up.
- Name
legalAccepted?
- Type
boolean
- Description
A boolean indicating whether the user has agreed to the legal compliance documents.
authenticateWithWeb3()
Starts a sign-up flow that authenticates the user against their public Web3 wallet address.
- Name
identifier
- Type
string
- Description
The user's Web3 ID
- Name
generateSignature
- Type
(opts: GenerateSignatureParams) => Promise<string>
- Description
The method of how to generate the signature for the Web3 sign-in. See
GenerateSignatureParams
for more information.
- Name
strategy?
- Type
Web3Strategy
- Description
The Web3 verification strategy.
- Name
legalAccepted?
- Type
boolean
- Description
A boolean indicating whether the user has agreed to the legal compliance documents.
- Name
identifier
- Type
string
- Description
The user's Web3 wallet address.
- Name
nonce
- Type
string
- Description
The cryptographic nonce used in the sign-in.
- Name
provider?
- Type
Web3Provider
- Description
The Web3 provider to generate the signature with.
- Name
legalAccepted?
- Type
boolean
- Description
A boolean indicating whether the user has agreed to the legal compliance documents.
authenticateWithMetamask()
Starts a sign-up flow that uses the Metamask browser extension to authenticate the user using their public Web3 wallet address.
- Name
unsafeMetadata
- Type
SignUpUnsafeMetadata
- Description
Custom fields that will be attached to the
User
object post-signup.
- Name
legalAccepted?
- Type
boolean
- Description
A boolean indicating whether the user has agreed to the legal compliance documents.
authenticateWithCoinbaseWallet()
Starts a sign-up flow that uses the Coinbase Wallet to authenticate the user using their public Web3 wallet address.
authenticateWithOKXWallet()
Starts a sign-up flow that uses the OKX Wallet to authenticate the user using their public Web3 wallet address.
- Name
unsafeMetadata
- Type
SignUpUnsafeMetadata
- Description
Custom fields that will be attached to the
User
object post-signup.
Feedback
Last updated on