AuthenticateWith
These are all methods on the SignUp class that allow you to authenticate with different methods.
authenticateWithRedirect()
function authenticateWithRedirect(params: AuthenticateWithRedirectParams): Promise<void>;
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.
AuthenticateWithRedirectParams
| Name | Type | Description |
|---|---|---|
redirectUrl | string | Full URL or path to the route that will complete the OAuth or SAML flow. Typically, this will be a simple /sso-callback route that calls Clerk.handleRedirectCallback or mounts the <AuthenticateWithRedirectCallback /> component. |
redirectUrlComplete | string | Full URL or path to navigate after the OAuth or SAML flow completes. |
continueSignUp | boolean | undefined | Whether to continue (i.e. PATCH) an existing SignUp (if present) or create a new SignUp. |
strategy | 'oauth_<provider>' | 'saml' | The strategy to use for authentication. The following strategies are supported:
|
identifier | string | undefined | Identifier to use for targeting a SAML connection at sign-up. |
emailAddress | string | undefined | Email address to use for targeting a SAML connection at sign-up. |
authenticateWithWeb3()
Starts a sign up flow that authenticates the user against their public wallet address.
AuthenticateWithWeb3Params
| Name | Type | Description |
|---|---|---|
identifier | string | The user's Web3 ID |
generateSignature | (opts: GenerateSignatureParams) => Promise<string> | The method of how to generate the signature for the Web3 sign-in. See GenerateSignatureParams for more details. |
GenerateSignatureParams
| Name | Type | Description |
|---|---|---|
identifier | string | The user's Web3 ID |
nonce | string | The cryptographic nonce used in the sign-in. |
authenticateWithMetamask()
function authenticateWithMetamask(params?: SignUpAuthenticateWithMetamaskParams): Promise<SignUp>;
Starts a sign up flow that uses the Metamask browser extension to authenticate the user using their public wallet address.
SignUpAuthenticateWithMetamaskParams
| Name | Type | Description |
|---|---|---|
unsafeMetadata | {[string]: any} | Custom fields that will be attached to the User object post-signup. |
Last updated on October 5, 2023